Data.Cloud.AmazonAPI.TAmazonStorageService.ListMultipartUploads

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

function ListMultipartUploads(const BucketName: string;  const OptionalParams: TStrings; ResponseInfo: TCloudResponseInfo = nil; BucketRegion: TAmazonRegion = amzrNotSpecified): TAmazonMultipartUploadsResult;

C++

TAmazonMultipartUploadsResult* __fastcall ListMultipartUploads(const System::UnicodeString BucketName, System::Classes::TStrings* const OptionalParams, Data::Cloud::Cloudapi::TCloudResponseInfo* ResponseInfo = (Data::Cloud::Cloudapi::TCloudResponseInfo*)(0x0), TAmazonRegion BucketRegion = (TAmazonRegion)(0x0));

Properties

Type Visibility Source Unit Parent
function public
Data.Cloud.AmazonAPI.pas
Data.Cloud.AmazonAPI.hpp
Data.Cloud.AmazonAPI TAmazonStorageService

Description

Returns a list of the current active multipart uploads.

ListMultipartUploads lists in-progress multipart uploads and all of their parts.

The call returns, at most, 1000 result items. The supported optional parameters include:

  • delimiter: Used to group keys or traverse a virtual directory structure (for example, '/').
  • prefix: Limits the response to object names that begin with the specified prefix.
  • max-uploads: Integer in the range from 1 through 1000. Maximum number of items to return.
  • key-marker: Indicates the file at each to begin populating. If upload-id-marker is not specified, then the populating begins from the next file after this file name. Otherwise, populating begins at the next upload part if one exists, or at the next file.
  • upload-id-marker: Specifies the multipart upload item to continue populating from.

The method returns the active multipart upload list.

The following table shows the significance of the parameters:

Parameter Description

BucketName

The name of the bucket to get the list of active multipart uploads for.

OptionalParams

The optional request parameters.

ResponseInfo

The optional class for storing response info into.

See Also