Copyright | (c) 2013-2017 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 |
Returns metadata about all of the versions of objects in a bucket.
This operation returns paginated results.
- listObjectVersions :: BucketName -> ListObjectVersions
- data ListObjectVersions
- lovKeyMarker :: Lens' ListObjectVersions (Maybe Text)
- lovPrefix :: Lens' ListObjectVersions (Maybe Text)
- lovEncodingType :: Lens' ListObjectVersions (Maybe EncodingType)
- lovVersionIdMarker :: Lens' ListObjectVersions (Maybe Text)
- lovMaxKeys :: Lens' ListObjectVersions (Maybe Int)
- lovDelimiter :: Lens' ListObjectVersions (Maybe Delimiter)
- lovBucket :: Lens' ListObjectVersions BucketName
- listObjectVersionsResponse :: Int -> ListObjectVersionsResponse
- data ListObjectVersionsResponse
- lovrsNextVersionIdMarker :: Lens' ListObjectVersionsResponse (Maybe Text)
- lovrsKeyMarker :: Lens' ListObjectVersionsResponse (Maybe Text)
- lovrsDeleteMarkers :: Lens' ListObjectVersionsResponse [DeleteMarkerEntry]
- lovrsPrefix :: Lens' ListObjectVersionsResponse (Maybe Text)
- lovrsCommonPrefixes :: Lens' ListObjectVersionsResponse [CommonPrefix]
- lovrsEncodingType :: Lens' ListObjectVersionsResponse (Maybe EncodingType)
- lovrsVersions :: Lens' ListObjectVersionsResponse [ObjectVersion]
- lovrsName :: Lens' ListObjectVersionsResponse (Maybe BucketName)
- lovrsNextKeyMarker :: Lens' ListObjectVersionsResponse (Maybe Text)
- lovrsVersionIdMarker :: Lens' ListObjectVersionsResponse (Maybe Text)
- lovrsMaxKeys :: Lens' ListObjectVersionsResponse (Maybe Int)
- lovrsIsTruncated :: Lens' ListObjectVersionsResponse (Maybe Bool)
- lovrsDelimiter :: Lens' ListObjectVersionsResponse (Maybe Delimiter)
- lovrsResponseStatus :: Lens' ListObjectVersionsResponse Int
Creating a Request
Creates a value of ListObjectVersions
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
lovKeyMarker
- Specifies the key to start with when listing objects in a bucket.lovPrefix
- Limits the response to keys that begin with the specified prefix.lovEncodingType
- Undocumented member.lovVersionIdMarker
- Specifies the object version you want to start listing from.lovMaxKeys
- Sets the maximum number of keys returned in the response. The response might contain fewer keys but will never contain more.lovDelimiter
- A delimiter is a character you use to group keys.lovBucket
- Undocumented member.
data ListObjectVersions Source #
See: listObjectVersions
smart constructor.
Request Lenses
lovKeyMarker :: Lens' ListObjectVersions (Maybe Text) Source #
Specifies the key to start with when listing objects in a bucket.
lovPrefix :: Lens' ListObjectVersions (Maybe Text) Source #
Limits the response to keys that begin with the specified prefix.
lovEncodingType :: Lens' ListObjectVersions (Maybe EncodingType) Source #
Undocumented member.
lovVersionIdMarker :: Lens' ListObjectVersions (Maybe Text) Source #
Specifies the object version you want to start listing from.
lovMaxKeys :: Lens' ListObjectVersions (Maybe Int) Source #
Sets the maximum number of keys returned in the response. The response might contain fewer keys but will never contain more.
lovDelimiter :: Lens' ListObjectVersions (Maybe Delimiter) Source #
A delimiter is a character you use to group keys.
lovBucket :: Lens' ListObjectVersions BucketName Source #
Undocumented member.
Destructuring the Response
listObjectVersionsResponse Source #
Creates a value of ListObjectVersionsResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
lovrsNextVersionIdMarker
- Use this value for the next version id marker parameter in a subsequent request.lovrsKeyMarker
- Marks the last Key returned in a truncated response.lovrsDeleteMarkers
- Undocumented member.lovrsPrefix
- Undocumented member.lovrsCommonPrefixes
- Undocumented member.lovrsEncodingType
- Encoding type used by Amazon S3 to encode object keys in the response.lovrsVersions
- Undocumented member.lovrsName
- Undocumented member.lovrsNextKeyMarker
- Use this value for the key marker request parameter in a subsequent request.lovrsVersionIdMarker
- Undocumented member.lovrsMaxKeys
- Undocumented member.lovrsIsTruncated
- A flag that indicates whether or not Amazon S3 returned all of the results that satisfied the search criteria. If your results were truncated, you can make a follow-up paginated request using the NextKeyMarker and NextVersionIdMarker response parameters as a starting place in another request to return the rest of the results.lovrsDelimiter
- Undocumented member.lovrsResponseStatus
- -- | The response status code.
data ListObjectVersionsResponse Source #
See: listObjectVersionsResponse
smart constructor.
Response Lenses
lovrsNextVersionIdMarker :: Lens' ListObjectVersionsResponse (Maybe Text) Source #
Use this value for the next version id marker parameter in a subsequent request.
lovrsKeyMarker :: Lens' ListObjectVersionsResponse (Maybe Text) Source #
Marks the last Key returned in a truncated response.
lovrsDeleteMarkers :: Lens' ListObjectVersionsResponse [DeleteMarkerEntry] Source #
Undocumented member.
lovrsPrefix :: Lens' ListObjectVersionsResponse (Maybe Text) Source #
Undocumented member.
lovrsCommonPrefixes :: Lens' ListObjectVersionsResponse [CommonPrefix] Source #
Undocumented member.
lovrsEncodingType :: Lens' ListObjectVersionsResponse (Maybe EncodingType) Source #
Encoding type used by Amazon S3 to encode object keys in the response.
lovrsVersions :: Lens' ListObjectVersionsResponse [ObjectVersion] Source #
Undocumented member.
lovrsName :: Lens' ListObjectVersionsResponse (Maybe BucketName) Source #
Undocumented member.
lovrsNextKeyMarker :: Lens' ListObjectVersionsResponse (Maybe Text) Source #
Use this value for the key marker request parameter in a subsequent request.
lovrsVersionIdMarker :: Lens' ListObjectVersionsResponse (Maybe Text) Source #
Undocumented member.
lovrsMaxKeys :: Lens' ListObjectVersionsResponse (Maybe Int) Source #
Undocumented member.
lovrsIsTruncated :: Lens' ListObjectVersionsResponse (Maybe Bool) Source #
A flag that indicates whether or not Amazon S3 returned all of the results that satisfied the search criteria. If your results were truncated, you can make a follow-up paginated request using the NextKeyMarker and NextVersionIdMarker response parameters as a starting place in another request to return the rest of the results.
lovrsDelimiter :: Lens' ListObjectVersionsResponse (Maybe Delimiter) Source #
Undocumented member.
lovrsResponseStatus :: Lens' ListObjectVersionsResponse Int Source #
- - | The response status code.