Copyright | (c) 2013-2015 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
This operation lists the parts of an archive that have been uploaded in a specific multipart upload. You can make this request at any time during an in-progress multipart upload before you complete the upload (see CompleteMultipartUpload. List Parts returns an error for completed uploads. The list returned in the List Parts response is sorted by part range.
The List Parts operation supports pagination. By default, this operation
returns up to 1,000 uploaded parts in the response. You should always
check the response for a marker
at which to continue the list; if
there are no more items the marker
is null
. To return a list of
parts that begins at a specific part, set the marker
request parameter
to the value you obtained from a previous List Parts request. You can
also limit the number of parts returned in the response by specifying
the limit
parameter in the request.
An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM).
For conceptual information and the underlying REST API, go to Working with Archives in Amazon Glacier and List Parts in the Amazon Glacier Developer Guide.
See: AWS API Reference for ListParts.
This operation returns paginated results.
- listParts :: Text -> Text -> Text -> ListParts
- data ListParts
- lpMarker :: Lens' ListParts (Maybe Text)
- lpLimit :: Lens' ListParts (Maybe Text)
- lpAccountId :: Lens' ListParts Text
- lpVaultName :: Lens' ListParts Text
- lpUploadId :: Lens' ListParts Text
- listPartsResponse :: Int -> ListPartsResponse
- data ListPartsResponse
- lprsParts :: Lens' ListPartsResponse [PartListElement]
- lprsMultipartUploadId :: Lens' ListPartsResponse (Maybe Text)
- lprsPartSizeInBytes :: Lens' ListPartsResponse (Maybe Integer)
- lprsArchiveDescription :: Lens' ListPartsResponse (Maybe Text)
- lprsVaultARN :: Lens' ListPartsResponse (Maybe Text)
- lprsMarker :: Lens' ListPartsResponse (Maybe Text)
- lprsCreationDate :: Lens' ListPartsResponse (Maybe Text)
- lprsResponseStatus :: Lens' ListPartsResponse Int
Creating a Request
Creates a value of ListParts
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
Provides options for retrieving a list of parts of an archive that have been uploaded in a specific multipart upload.
See: listParts
smart constructor.
Request Lenses
lpMarker :: Lens' ListParts (Maybe Text) Source #
An opaque string used for pagination. This value specifies the part at which the listing of parts should begin. Get the marker value from the response of a previous List Parts response. You need only include the marker if you are continuing the pagination of results started in a previous List Parts request.
lpLimit :: Lens' ListParts (Maybe Text) Source #
Specifies the maximum number of parts returned in the response body. If this value is not specified, the List Parts operation returns up to 1,000 uploads.
lpAccountId :: Lens' ListParts Text Source #
The AccountId
value is the AWS account ID of the account that owns the
vault. You can either specify an AWS account ID or optionally a single
apos-
apos (hyphen), in which case Amazon Glacier uses the AWS account
ID associated with the credentials used to sign the request. If you use
an account ID, do not include any hyphens (apos-apos) in the ID.
Destructuring the Response
Creates a value of ListPartsResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data ListPartsResponse Source #
Contains the Amazon Glacier response to your request.
See: listPartsResponse
smart constructor.
Response Lenses
lprsParts :: Lens' ListPartsResponse [PartListElement] Source #
A list of the part sizes of the multipart upload.
lprsMultipartUploadId :: Lens' ListPartsResponse (Maybe Text) Source #
The ID of the upload to which the parts are associated.
lprsPartSizeInBytes :: Lens' ListPartsResponse (Maybe Integer) Source #
The part size in bytes.
lprsArchiveDescription :: Lens' ListPartsResponse (Maybe Text) Source #
The description of the archive that was specified in the Initiate Multipart Upload request.
lprsVaultARN :: Lens' ListPartsResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) of the vault to which the multipart upload was initiated.
lprsMarker :: Lens' ListPartsResponse (Maybe Text) Source #
An opaque string that represents where to continue pagination of the
results. You use the marker in a new List Parts request to obtain more
jobs in the list. If there are no more parts, this value is null
.
lprsCreationDate :: Lens' ListPartsResponse (Maybe Text) Source #
The UTC time at which the multipart upload was initiated.
lprsResponseStatus :: Lens' ListPartsResponse Int Source #
The response status code.