Data.Cloud.AmazonAPI.TAmazonStorageService.SetBucketNotification

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

function SetBucketNotification(const BucketName: string; Events: TList<TAmazonNotificationEvent>;  ResponseInfo: TCloudResponseInfo = nil; const BucketRegion: TAmazonRegion = amzrNotSpecified): Boolean;

C++

bool __fastcall SetBucketNotification(const System::UnicodeString BucketName, System::Generics::Collections::TList__1<TAmazonNotificationEvent>* Events, Data::Cloud::Cloudapi::TCloudResponseInfo* ResponseInfo = (Data::Cloud::Cloudapi::TCloudResponseInfo*)(0x0), const System::UnicodeString BucketRegion = System::UnicodeString());

Properties

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

Description

Sets the notification events for the given bucket.

If Events is nil or an empty list, then notifications are disabled for this bucket. See TAmazonNotificationEvent for more information on supported events. The method returns True if setting is successful, False otherwise.

SetBucketNotification accepts the following parameters:

  • BucketName: The name of the bucket to set the notification events for.
  • Events: A list of notification events to set.
  • ResponseInfo: Optional. Holds the response information.
  • BucketRegion: Optional. The region of the bucket to set the notification events 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