Data.Cloud.AmazonAPI.TAmazonStorageService.DeleteObjectVersion

From RAD Studio API Documentation
Jump to: navigation, search

[–] Properties
Type: function
Visibility: public
Source:
Data.Cloud.AmazonAPI.pas
Data.Cloud.AmazonAPI.hpp
Unit: Data.Cloud.AmazonAPI
Parent: TAmazonStorageService

Delphi

function DeleteObjectVersion(const BucketName, ObjectName, VersionId: string;
ResponseInfo: TCloudResponseInfo = nil;
const BucketRegion: TAmazonRegion = amzrNotSpecified): Boolean;

C++

bool __fastcall DeleteObjectVersion(const System::UnicodeString BucketName, const System::UnicodeString ObjectName, const System::UnicodeString VersionId, Data::Cloud::Cloudapi::TCloudResponseInfo* ResponseInfo = (Data::Cloud::Cloudapi::TCloudResponseInfo*)(0x0), const TAmazonRegion BucketRegion = System::UnicodeString());

Description

Deletes the specified object's version from the given bucket.

You must be the bucket owner to call DeleteObjectVersion. If the specified version is a delete marker and you have provided a ResponseInfo instance, then an x-amz-marker header will be added with a value of True.

If MFA Delete is enabled, then this call will need to be made over HTTPS and values must be set on the connection for the MFA Serial Number and MFA Authentication Code.

The method returns True if successful, and False otherwise.

The following table shows the significance of the parameters:

Parameter Description

BucketName

The name of the bucket to delete the object version from.

ObjectName

The name of the object to delete a version of.

VersionId

The name of the object to delete.

ResponseInfo

The optional class for storing response info into.

See Also