Copyright	(c) 2013-2018 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None
Language	Haskell2010

Network.AWS.S3.ListObjects

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

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

listObjects :: BucketName -> ListObjects
data ListObjects
loPrefix :: Lens' ListObjects (Maybe Text)
loEncodingType :: Lens' ListObjects (Maybe EncodingType)
loRequestPayer :: Lens' ListObjects (Maybe RequestPayer)
loMarker :: Lens' ListObjects (Maybe Text)
loMaxKeys :: Lens' ListObjects (Maybe Int)
loDelimiter :: Lens' ListObjects (Maybe Delimiter)
loBucket :: Lens' ListObjects BucketName
listObjectsResponse :: Int -> ListObjectsResponse
data ListObjectsResponse
lorsContents :: Lens' ListObjectsResponse [Object]
lorsPrefix :: Lens' ListObjectsResponse (Maybe Text)
lorsCommonPrefixes :: Lens' ListObjectsResponse [CommonPrefix]
lorsEncodingType :: Lens' ListObjectsResponse (Maybe EncodingType)
lorsName :: Lens' ListObjectsResponse (Maybe BucketName)
lorsMarker :: Lens' ListObjectsResponse (Maybe Text)
lorsNextMarker :: Lens' ListObjectsResponse (Maybe Text)
lorsMaxKeys :: Lens' ListObjectsResponse (Maybe Int)
lorsIsTruncated :: Lens' ListObjectsResponse (Maybe Bool)
lorsDelimiter :: Lens' ListObjectsResponse (Maybe Delimiter)
lorsResponseStatus :: Lens' ListObjectsResponse Int

Creating a Request

listObjects #

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 #

See: listObjects smart constructor.

Instances

Eq ListObjects #
Instance details Defined in Network.AWS.S3.ListObjects Methods (==) :: ListObjects -> ListObjects -> Bool # (/=) :: ListObjects -> ListObjects -> Bool #
Data ListObjects #
Instance details Defined in Network.AWS.S3.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 #
Instance details Defined in Network.AWS.S3.ListObjects Methods readsPrec :: Int -> ReadS ListObjects # readList :: ReadS [ListObjects] # readPrec :: ReadPrec ListObjects # readListPrec :: ReadPrec [ListObjects] #
Show ListObjects #
Instance details Defined in Network.AWS.S3.ListObjects Methods showsPrec :: Int -> ListObjects -> ShowS # show :: ListObjects -> String # showList :: [ListObjects] -> ShowS #
Generic ListObjects #
Instance details Defined in Network.AWS.S3.ListObjects Associated Types type Rep ListObjects :: Type -> Type # Methods from :: ListObjects -> Rep ListObjects x # to :: Rep ListObjects x -> ListObjects #
Hashable ListObjects #
Instance details Defined in Network.AWS.S3.ListObjects Methods hashWithSalt :: Int -> ListObjects -> Int # hash :: ListObjects -> Int #
AWSPager ListObjects #
Instance details Defined in Network.AWS.S3.ListObjects Methods page :: ListObjects -> Rs ListObjects -> Maybe ListObjects #
AWSRequest ListObjects #
Instance details Defined in Network.AWS.S3.ListObjects Associated Types type Rs ListObjects :: Type # Methods request :: ListObjects -> Request ListObjects # response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy ListObjects -> ClientResponse -> m (Response ListObjects) #
ToHeaders ListObjects #
Instance details Defined in Network.AWS.S3.ListObjects Methods toHeaders :: ListObjects -> [Header] #
ToPath ListObjects #
Instance details Defined in Network.AWS.S3.ListObjects Methods toPath :: ListObjects -> ByteString #
ToQuery ListObjects #
Instance details Defined in Network.AWS.S3.ListObjects Methods toQuery :: ListObjects -> QueryString #
NFData ListObjects #
Instance details Defined in Network.AWS.S3.ListObjects Methods rnf :: ListObjects -> () #
type Rep ListObjects #
Instance details Defined in Network.AWS.S3.ListObjects type Rep ListObjects = D1 (MetaData "ListObjects" "Network.AWS.S3.ListObjects" "amazonka-s3-1.6.1-LiqvNF3p5E63pl94gDJb0i" False) (C1 (MetaCons "ListObjects'" PrefixI True) ((S1 (MetaSel (Just "_loPrefix") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: (S1 (MetaSel (Just "_loEncodingType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe EncodingType)) :: S1 (MetaSel (Just "_loRequestPayer") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe RequestPayer)))) :: ((S1 (MetaSel (Just "_loMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_loMaxKeys") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Int))) :: (S1 (MetaSel (Just "_loDelimiter") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Delimiter)) :: S1 (MetaSel (Just "_loBucket") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 BucketName)))))
type Rs ListObjects #
Instance details Defined in Network.AWS.S3.ListObjects type Rs ListObjects = ListObjectsResponse

Request Lenses

loPrefix :: Lens' ListObjects (Maybe Text) #

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

loEncodingType :: Lens' ListObjects (Maybe EncodingType) #

Undocumented member.

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 #

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 #

See: listObjectsResponse smart constructor.

Instances

Eq ListObjectsResponse #
Instance details Defined in Network.AWS.S3.ListObjects Methods (==) :: ListObjectsResponse -> ListObjectsResponse -> Bool # (/=) :: ListObjectsResponse -> ListObjectsResponse -> Bool #
Data ListObjectsResponse #
Instance details Defined in Network.AWS.S3.ListObjects 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 #
Instance details Defined in Network.AWS.S3.ListObjects Methods readsPrec :: Int -> ReadS ListObjectsResponse # readList :: ReadS [ListObjectsResponse] # readPrec :: ReadPrec ListObjectsResponse # readListPrec :: ReadPrec [ListObjectsResponse] #
Show ListObjectsResponse #
Instance details Defined in Network.AWS.S3.ListObjects Methods showsPrec :: Int -> ListObjectsResponse -> ShowS # show :: ListObjectsResponse -> String # showList :: [ListObjectsResponse] -> ShowS #
Generic ListObjectsResponse #
Instance details Defined in Network.AWS.S3.ListObjects Associated Types type Rep ListObjectsResponse :: Type -> Type # Methods from :: ListObjectsResponse -> Rep ListObjectsResponse x # to :: Rep ListObjectsResponse x -> ListObjectsResponse #
NFData ListObjectsResponse #
Instance details Defined in Network.AWS.S3.ListObjects Methods rnf :: ListObjectsResponse -> () #
type Rep ListObjectsResponse #
Instance details Defined in Network.AWS.S3.ListObjects type Rep ListObjectsResponse = D1 (MetaData "ListObjectsResponse" "Network.AWS.S3.ListObjects" "amazonka-s3-1.6.1-LiqvNF3p5E63pl94gDJb0i" False) (C1 (MetaCons "ListObjectsResponse'" PrefixI True) (((S1 (MetaSel (Just "_lorsContents") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Object])) :: S1 (MetaSel (Just "_lorsPrefix") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :: (S1 (MetaSel (Just "_lorsCommonPrefixes") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [CommonPrefix])) :: (S1 (MetaSel (Just "_lorsEncodingType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe EncodingType)) :: S1 (MetaSel (Just "_lorsName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe BucketName))))) :: ((S1 (MetaSel (Just "_lorsMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: (S1 (MetaSel (Just "_lorsNextMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_lorsMaxKeys") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Int)))) :: (S1 (MetaSel (Just "_lorsIsTruncated") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool)) :: (S1 (MetaSel (Just "_lorsDelimiter") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Delimiter)) :: S1 (MetaSel (Just "_lorsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int))))))

Response Lenses

lorsContents :: Lens' ListObjectsResponse [Object] #

Undocumented member.

lorsPrefix :: Lens' ListObjectsResponse (Maybe Text) #

Undocumented member.

lorsCommonPrefixes :: Lens' ListObjectsResponse [CommonPrefix] #

Undocumented member.

lorsEncodingType :: Lens' ListObjectsResponse (Maybe EncodingType) #

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

lorsName :: Lens' ListObjectsResponse (Maybe BucketName) #

Undocumented member.

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.

lorsDelimiter :: Lens' ListObjectsResponse (Maybe Delimiter) #

Undocumented member.

lorsResponseStatus :: Lens' ListObjectsResponse Int #

- | The response status code.