Copyright | (c) 2013-2021 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 |
Lists the parts that have been uploaded for a specific multipart upload.
This operation must include the upload ID, which you obtain by sending
the initiate multipart upload request (see
CreateMultipartUpload).
This request returns a maximum of 1,000 uploaded parts. The default
number of parts returned is 1,000 parts. You can restrict the number of
parts returned by specifying the max-parts
request parameter. If your
multipart upload consists of more than 1,000 parts, the response returns
an IsTruncated
field with the value of true, and a
NextPartNumberMarker
element. In subsequent ListParts
requests you
can include the part-number-marker query string parameter and set its
value to the NextPartNumberMarker
field value from the previous
response.
For more information on multipart uploads, see Uploading Objects Using Multipart Upload.
For information on permissions required to use the multipart upload API, see Multipart Upload and Permissions.
The following operations are related to ListParts
:
This operation returns paginated results.
Synopsis
- data ListParts = ListParts' {}
- newListParts :: BucketName -> ObjectKey -> Text -> ListParts
- listParts_maxParts :: Lens' ListParts (Maybe Int)
- listParts_requestPayer :: Lens' ListParts (Maybe RequestPayer)
- listParts_partNumberMarker :: Lens' ListParts (Maybe Int)
- listParts_expectedBucketOwner :: Lens' ListParts (Maybe Text)
- listParts_bucket :: Lens' ListParts BucketName
- listParts_key :: Lens' ListParts ObjectKey
- listParts_uploadId :: Lens' ListParts Text
- data ListPartsResponse = ListPartsResponse' {
- parts :: Maybe [Part]
- requestCharged :: Maybe RequestCharged
- maxParts :: Maybe Int
- initiator :: Maybe Initiator
- bucket :: Maybe BucketName
- abortDate :: Maybe ISO8601
- nextPartNumberMarker :: Maybe Int
- abortRuleId :: Maybe Text
- owner :: Maybe Owner
- key :: Maybe ObjectKey
- storageClass :: Maybe StorageClass
- isTruncated :: Maybe Bool
- partNumberMarker :: Maybe Int
- uploadId :: Maybe Text
- httpStatus :: Int
- newListPartsResponse :: Int -> ListPartsResponse
- listPartsResponse_parts :: Lens' ListPartsResponse (Maybe [Part])
- listPartsResponse_requestCharged :: Lens' ListPartsResponse (Maybe RequestCharged)
- listPartsResponse_maxParts :: Lens' ListPartsResponse (Maybe Int)
- listPartsResponse_initiator :: Lens' ListPartsResponse (Maybe Initiator)
- listPartsResponse_bucket :: Lens' ListPartsResponse (Maybe BucketName)
- listPartsResponse_abortDate :: Lens' ListPartsResponse (Maybe UTCTime)
- listPartsResponse_nextPartNumberMarker :: Lens' ListPartsResponse (Maybe Int)
- listPartsResponse_abortRuleId :: Lens' ListPartsResponse (Maybe Text)
- listPartsResponse_owner :: Lens' ListPartsResponse (Maybe Owner)
- listPartsResponse_key :: Lens' ListPartsResponse (Maybe ObjectKey)
- listPartsResponse_storageClass :: Lens' ListPartsResponse (Maybe StorageClass)
- listPartsResponse_isTruncated :: Lens' ListPartsResponse (Maybe Bool)
- listPartsResponse_partNumberMarker :: Lens' ListPartsResponse (Maybe Int)
- listPartsResponse_uploadId :: Lens' ListPartsResponse (Maybe Text)
- listPartsResponse_httpStatus :: Lens' ListPartsResponse Int
Creating a Request
See: newListParts
smart constructor.
ListParts' | |
|
Instances
:: BucketName | |
-> ObjectKey | |
-> Text | |
-> ListParts |
Create a value of ListParts
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxParts:ListParts'
, listParts_maxParts
- Sets the maximum number of parts to return.
$sel:requestPayer:ListParts'
, listParts_requestPayer
- Undocumented member.
$sel:partNumberMarker:ListParts'
, listParts_partNumberMarker
- Specifies the part after which listing should begin. Only parts with
higher part numbers will be listed.
$sel:expectedBucketOwner:ListParts'
, listParts_expectedBucketOwner
- The account ID of the expected bucket owner. If the bucket is owned by a
different account, the request will fail with an HTTP
403 (Access Denied)
error.
$sel:bucket:ListParts'
, listParts_bucket
- The name of the bucket to which the parts are being uploaded.
When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.
When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action using S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon S3 User Guide.
$sel:key:ListParts'
, listParts_key
- Object key for which the multipart upload was initiated.
$sel:uploadId:ListParts'
, listParts_uploadId
- Upload ID identifying the multipart upload whose parts are being listed.
Request Lenses
listParts_maxParts :: Lens' ListParts (Maybe Int) Source #
Sets the maximum number of parts to return.
listParts_requestPayer :: Lens' ListParts (Maybe RequestPayer) Source #
Undocumented member.
listParts_partNumberMarker :: Lens' ListParts (Maybe Int) Source #
Specifies the part after which listing should begin. Only parts with higher part numbers will be listed.
listParts_expectedBucketOwner :: Lens' ListParts (Maybe Text) Source #
The account ID of the expected bucket owner. If the bucket is owned by a
different account, the request will fail with an HTTP
403 (Access Denied)
error.
listParts_bucket :: Lens' ListParts BucketName Source #
The name of the bucket to which the parts are being uploaded.
When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.
When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action using S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon S3 User Guide.
listParts_key :: Lens' ListParts ObjectKey Source #
Object key for which the multipart upload was initiated.
listParts_uploadId :: Lens' ListParts Text Source #
Upload ID identifying the multipart upload whose parts are being listed.
Destructuring the Response
data ListPartsResponse Source #
See: newListPartsResponse
smart constructor.
ListPartsResponse' | |
|
Instances
Create a value of ListPartsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:parts:ListPartsResponse'
, listPartsResponse_parts
- Container for elements related to a particular part. A response can
contain zero or more Part
elements.
$sel:requestCharged:ListPartsResponse'
, listPartsResponse_requestCharged
- Undocumented member.
$sel:maxParts:ListParts'
, listPartsResponse_maxParts
- Maximum number of parts that were allowed in the response.
$sel:initiator:ListPartsResponse'
, listPartsResponse_initiator
- Container element that identifies who initiated the multipart upload. If
the initiator is an Amazon Web Services account, this element provides
the same information as the Owner
element. If the initiator is an IAM
User, this element provides the user ARN and display name.
$sel:bucket:ListParts'
, listPartsResponse_bucket
- The name of the bucket to which the multipart upload was initiated. Does
not return the access point ARN or access point alias if used.
$sel:abortDate:ListPartsResponse'
, listPartsResponse_abortDate
- If the bucket has a lifecycle rule configured with an action to abort
incomplete multipart uploads and the prefix in the lifecycle rule
matches the object name in the request, then the response includes this
header indicating when the initiated multipart upload will become
eligible for abort operation. For more information, see
Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Policy.
The response will also include the x-amz-abort-rule-id
header that
will provide the ID of the lifecycle configuration rule that defines
this action.
$sel:nextPartNumberMarker:ListPartsResponse'
, listPartsResponse_nextPartNumberMarker
- When a list is truncated, this element specifies the last part in the
list, as well as the value to use for the part-number-marker request
parameter in a subsequent request.
$sel:abortRuleId:ListPartsResponse'
, listPartsResponse_abortRuleId
- This header is returned along with the x-amz-abort-date
header. It
identifies applicable lifecycle configuration rule that defines the
action to abort incomplete multipart uploads.
$sel:owner:ListPartsResponse'
, listPartsResponse_owner
- Container element that identifies the object owner, after the object is
created. If multipart upload is initiated by an IAM user, this element
provides the parent account ID and display name.
$sel:key:ListParts'
, listPartsResponse_key
- Object key for which the multipart upload was initiated.
$sel:storageClass:ListPartsResponse'
, listPartsResponse_storageClass
- Class of storage (STANDARD or REDUCED_REDUNDANCY) used to store the
uploaded object.
$sel:isTruncated:ListPartsResponse'
, listPartsResponse_isTruncated
- Indicates whether the returned list of parts is truncated. A true value
indicates that the list was truncated. A list can be truncated if the
number of parts exceeds the limit returned in the MaxParts element.
$sel:partNumberMarker:ListParts'
, listPartsResponse_partNumberMarker
- When a list is truncated, this element specifies the last part in the
list, as well as the value to use for the part-number-marker request
parameter in a subsequent request.
$sel:uploadId:ListParts'
, listPartsResponse_uploadId
- Upload ID identifying the multipart upload whose parts are being listed.
$sel:httpStatus:ListPartsResponse'
, listPartsResponse_httpStatus
- The response's http status code.
Response Lenses
listPartsResponse_parts :: Lens' ListPartsResponse (Maybe [Part]) Source #
Container for elements related to a particular part. A response can
contain zero or more Part
elements.
listPartsResponse_requestCharged :: Lens' ListPartsResponse (Maybe RequestCharged) Source #
Undocumented member.
listPartsResponse_maxParts :: Lens' ListPartsResponse (Maybe Int) Source #
Maximum number of parts that were allowed in the response.
listPartsResponse_initiator :: Lens' ListPartsResponse (Maybe Initiator) Source #
Container element that identifies who initiated the multipart upload. If
the initiator is an Amazon Web Services account, this element provides
the same information as the Owner
element. If the initiator is an IAM
User, this element provides the user ARN and display name.
listPartsResponse_bucket :: Lens' ListPartsResponse (Maybe BucketName) Source #
The name of the bucket to which the multipart upload was initiated. Does not return the access point ARN or access point alias if used.
listPartsResponse_abortDate :: Lens' ListPartsResponse (Maybe UTCTime) Source #
If the bucket has a lifecycle rule configured with an action to abort incomplete multipart uploads and the prefix in the lifecycle rule matches the object name in the request, then the response includes this header indicating when the initiated multipart upload will become eligible for abort operation. For more information, see Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Policy.
The response will also include the x-amz-abort-rule-id
header that
will provide the ID of the lifecycle configuration rule that defines
this action.
listPartsResponse_nextPartNumberMarker :: Lens' ListPartsResponse (Maybe Int) Source #
When a list is truncated, this element specifies the last part in the list, as well as the value to use for the part-number-marker request parameter in a subsequent request.
listPartsResponse_abortRuleId :: Lens' ListPartsResponse (Maybe Text) Source #
This header is returned along with the x-amz-abort-date
header. It
identifies applicable lifecycle configuration rule that defines the
action to abort incomplete multipart uploads.
listPartsResponse_owner :: Lens' ListPartsResponse (Maybe Owner) Source #
Container element that identifies the object owner, after the object is created. If multipart upload is initiated by an IAM user, this element provides the parent account ID and display name.
listPartsResponse_key :: Lens' ListPartsResponse (Maybe ObjectKey) Source #
Object key for which the multipart upload was initiated.
listPartsResponse_storageClass :: Lens' ListPartsResponse (Maybe StorageClass) Source #
Class of storage (STANDARD or REDUCED_REDUNDANCY) used to store the uploaded object.
listPartsResponse_isTruncated :: Lens' ListPartsResponse (Maybe Bool) Source #
Indicates whether the returned list of parts is truncated. A true value indicates that the list was truncated. A list can be truncated if the number of parts exceeds the limit returned in the MaxParts element.
listPartsResponse_partNumberMarker :: Lens' ListPartsResponse (Maybe Int) Source #
When a list is truncated, this element specifies the last part in the list, as well as the value to use for the part-number-marker request parameter in a subsequent request.
listPartsResponse_uploadId :: Lens' ListPartsResponse (Maybe Text) Source #
Upload ID identifying the multipart upload whose parts are being listed.
listPartsResponse_httpStatus :: Lens' ListPartsResponse Int Source #
The response's http status code.