Data.Cloud.AmazonAPI.TAmazonStorageService.GetRequestPayment

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 GetRequestPayment(const BucketName: string;
ResponseInfo: TCloudResponseInfo = nil;
const BucketRegion: TAmazonRegion = amzrNotSpecified): TAmazonPayer;

C++

TAmazonPayer __fastcall GetRequestPayment(const System::UnicodeString BucketName, Data::Cloud::Cloudapi::TCloudResponseInfo* ResponseInfo = (Data::Cloud::Cloudapi::TCloudResponseInfo*)(0x0), const TAmazonRegion BucketRegion = System::UnicodeString());

Description

Returns the user who pays for the given bucket's access.

GetRequestPayment returns the bucket's payer, or ampUnknown if the request fails.

The option is either the current requester (requires AWS authentication) or the bucket owner.

The following table shows the significance of the parameters:

Parameter Description

BucketName

The name of the bucket to get the payer information for.

ResponseInfo

The optional class for storing response info into.

See Also