Data.Cloud.AmazonAPI.TAmazonStorageService.GetBucketNotificationXML

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

C++

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

Description

Gets the notification configuration of a bucket.

GetBucketNotificationXML returns an XML representation of the notification configuration of a bucket.

If the request fails, this method returns nil. See TAmazonNotificationEvent for more information on supported notifications.

GetBucketNotificationXML accepts the following parameters:

  • BucketName: The name of the bucket to get the notification configuration for.
  • ResponseInfo: Optional. Holds the response information.
  • BucketRegion: Optional. The region of the bucket to get the notification configuration for. Default is amzrNotSpecified, which means that this method automatically detects the region of the bucket based on the name of the bucket.

See Also