| 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 |
Amazonka.S3.AbortMultipartUpload
Description
This action aborts a multipart upload. After a multipart upload is aborted, no additional parts can be uploaded using that upload ID. The storage consumed by any previously uploaded parts will be freed. However, if any part uploads are currently in progress, those part uploads might or might not succeed. As a result, it might be necessary to abort a given multipart upload multiple times in order to completely free all storage consumed by all parts.
To verify that all parts have been removed, so you don't get charged for the part storage, you should call the ListParts action and ensure that the parts list is empty.
For information about permissions required to use the multipart upload, see Multipart Upload and Permissions.
The following operations are related to AbortMultipartUpload:
Synopsis
- data AbortMultipartUpload = AbortMultipartUpload' {}
- newAbortMultipartUpload :: BucketName -> ObjectKey -> Text -> AbortMultipartUpload
- abortMultipartUpload_requestPayer :: Lens' AbortMultipartUpload (Maybe RequestPayer)
- abortMultipartUpload_expectedBucketOwner :: Lens' AbortMultipartUpload (Maybe Text)
- abortMultipartUpload_bucket :: Lens' AbortMultipartUpload BucketName
- abortMultipartUpload_key :: Lens' AbortMultipartUpload ObjectKey
- abortMultipartUpload_uploadId :: Lens' AbortMultipartUpload Text
- data AbortMultipartUploadResponse = AbortMultipartUploadResponse' {}
- newAbortMultipartUploadResponse :: Int -> AbortMultipartUploadResponse
- abortMultipartUploadResponse_requestCharged :: Lens' AbortMultipartUploadResponse (Maybe RequestCharged)
- abortMultipartUploadResponse_httpStatus :: Lens' AbortMultipartUploadResponse Int
Creating a Request
data AbortMultipartUpload Source #
See: newAbortMultipartUpload smart constructor.
Constructors
| AbortMultipartUpload' | |
Fields
| |
Instances
newAbortMultipartUpload Source #
Arguments
| :: BucketName | |
| -> ObjectKey | |
| -> Text | |
| -> AbortMultipartUpload |
Create a value of AbortMultipartUpload 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:requestPayer:AbortMultipartUpload', abortMultipartUpload_requestPayer - Undocumented member.
$sel:expectedBucketOwner:AbortMultipartUpload', abortMultipartUpload_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:AbortMultipartUpload', abortMultipartUpload_bucket - The bucket name to which the upload was taking place.
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:AbortMultipartUpload', abortMultipartUpload_key - Key of the object for which the multipart upload was initiated.
$sel:uploadId:AbortMultipartUpload', abortMultipartUpload_uploadId - Upload ID that identifies the multipart upload.
Request Lenses
abortMultipartUpload_requestPayer :: Lens' AbortMultipartUpload (Maybe RequestPayer) Source #
Undocumented member.
abortMultipartUpload_expectedBucketOwner :: Lens' AbortMultipartUpload (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.
abortMultipartUpload_bucket :: Lens' AbortMultipartUpload BucketName Source #
The bucket name to which the upload was taking place.
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.
abortMultipartUpload_key :: Lens' AbortMultipartUpload ObjectKey Source #
Key of the object for which the multipart upload was initiated.
abortMultipartUpload_uploadId :: Lens' AbortMultipartUpload Text Source #
Upload ID that identifies the multipart upload.
Destructuring the Response
data AbortMultipartUploadResponse Source #
See: newAbortMultipartUploadResponse smart constructor.
Constructors
| AbortMultipartUploadResponse' | |
Fields
| |
Instances
newAbortMultipartUploadResponse Source #
Create a value of AbortMultipartUploadResponse 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:requestCharged:AbortMultipartUploadResponse', abortMultipartUploadResponse_requestCharged - Undocumented member.
$sel:httpStatus:AbortMultipartUploadResponse', abortMultipartUploadResponse_httpStatus - The response's http status code.
Response Lenses
abortMultipartUploadResponse_requestCharged :: Lens' AbortMultipartUploadResponse (Maybe RequestCharged) Source #
Undocumented member.
abortMultipartUploadResponse_httpStatus :: Lens' AbortMultipartUploadResponse Int Source #
The response's http status code.