Safe Haskell | None |
---|---|
Language | Haskell2010 |
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.
http://docs.aws.amazon.com/AmazonS3/latest/API/ListObjects.html
- data ListObjects
- listObjects :: Text -> ListObjects
- loBucket :: Lens' ListObjects Text
- loDelimiter :: Lens' ListObjects (Maybe Text)
- loEncodingType :: Lens' ListObjects (Maybe EncodingType)
- loMarker :: Lens' ListObjects (Maybe Text)
- loMaxKeys :: Lens' ListObjects (Maybe Int)
- loPrefix :: Lens' ListObjects (Maybe Text)
- data ListObjectsResponse
- listObjectsResponse :: ListObjectsResponse
- lorCommonPrefixes :: Lens' ListObjectsResponse [CommonPrefix]
- lorContents :: Lens' ListObjectsResponse [Object]
- lorDelimiter :: Lens' ListObjectsResponse (Maybe Text)
- lorEncodingType :: Lens' ListObjectsResponse (Maybe EncodingType)
- lorIsTruncated :: Lens' ListObjectsResponse (Maybe Bool)
- lorMarker :: Lens' ListObjectsResponse (Maybe Text)
- lorMaxKeys :: Lens' ListObjectsResponse (Maybe Int)
- lorName :: Lens' ListObjectsResponse (Maybe Text)
- lorNextMarker :: Lens' ListObjectsResponse (Maybe Text)
- lorPrefix :: Lens' ListObjectsResponse (Maybe Text)
Request
data ListObjects Source
Request constructor
:: Text | |
-> ListObjects |
ListObjects
constructor.
The fields accessible through corresponding lenses are:
Request lenses
loDelimiter :: Lens' ListObjects (Maybe Text) Source
A delimiter is a character you use to group keys.
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.
loPrefix :: Lens' ListObjects (Maybe Text) Source
Limits the response to keys that begin with the specified prefix.
Response
Response constructor
listObjectsResponse :: ListObjectsResponse Source
ListObjectsResponse
constructor.
The fields accessible through corresponding lenses are:
Response lenses
lorEncodingType :: Lens' ListObjectsResponse (Maybe EncodingType) Source
Encoding type used by Amazon S3 to encode object keys in the response.
lorIsTruncated :: Lens' ListObjectsResponse (Maybe Bool) Source
A flag that indicates whether or not Amazon S3 returned all of the results that satisfied the search criteria.
lorNextMarker :: 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.