Struct aws_sdk_s3::client::fluent_builders::PutBucketNotificationConfiguration

pub struct PutBucketNotificationConfiguration { /* private fields */ }

Fluent builder constructing a request to PutBucketNotificationConfiguration.

Enables notifications of specified events for a bucket. For more information about event notifications, see Configuring Event Notifications.

Using this API, you can replace an existing notification configuration. The configuration is an XML file that defines the event types that you want Amazon S3 to publish and the destination where you want Amazon S3 to publish an event notification when it detects an event of the specified type.

By default, your bucket has no event notifications configured. That is, the notification configuration will be an empty NotificationConfiguration.

This action replaces the existing notification configuration with the configuration you include in the request body.

After Amazon S3 receives this request, it first verifies that any Amazon Simple Notification Service (Amazon SNS) or Amazon Simple Queue Service (Amazon SQS) destination exists, and that the bucket owner has permission to publish to it by sending a test notification. In the case of Lambda destinations, Amazon S3 verifies that the Lambda function permissions grant Amazon S3 permission to invoke the function from the Amazon S3 bucket. For more information, see Configuring Notifications for Amazon S3 Events.

You can disable notifications by adding the empty NotificationConfiguration element.

For more information about the number of event notification configurations that you can create per bucket, see Amazon S3 service quotas in Amazon Web Services General Reference.

By default, only the bucket owner can configure notifications on a bucket. However, bucket owners can use a bucket policy to grant permission to other users to set this configuration with s3:PutBucketNotification permission.

The PUT notification is an atomic operation. For example, suppose your notification configuration includes SNS topic, SQS queue, and Lambda function configurations. When you send a PUT request with this configuration, Amazon S3 sends test messages to your SNS topic. If the message fails, the entire PUT action will fail, and Amazon S3 will not add the configuration to your bucket.

Responses

If the configuration in the request body includes only one TopicConfiguration specifying only the s3:ReducedRedundancyLostObject event type, the response will also include the x-amz-sns-test-message-id header containing the message ID of the test notification sent to the topic.

The following action is related to PutBucketNotificationConfiguration:

• GetBucketNotificationConfiguration

Implementations

impl PutBucketNotificationConfiguration

pub async fn customize(
    self
) -> Result<CustomizableOperation<PutBucketNotificationConfiguration, AwsResponseRetryClassifier>, SdkError<PutBucketNotificationConfigurationError>>

Consume this builder, creating a customizable operation that can be modified before being sent. The operation’s inner http::Request can be modified as well.

pub async fn send(
    self
) -> Result<PutBucketNotificationConfigurationOutput, SdkError<PutBucketNotificationConfigurationError>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn bucket(self, input: impl Into<String>) -> Self

The name of the bucket.

pub fn set_bucket(self, input: Option<String>) -> Self

The name of the bucket.

pub fn notification_configuration(self, input: NotificationConfiguration) -> Self

A container for specifying the notification configuration of the bucket. If this element is empty, notifications are turned off for the bucket.

pub fn set_notification_configuration(
    self,
    input: Option<NotificationConfiguration>
) -> Self

A container for specifying the notification configuration of the bucket. If this element is empty, notifications are turned off for the bucket.

pub fn expected_bucket_owner(self, input: impl Into<String>) -> Self

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

pub fn set_expected_bucket_owner(self, input: Option<String>) -> Self

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

pub fn skip_destination_validation(self, input: bool) -> Self

Skips validation of Amazon SQS, Amazon SNS, and Lambda destinations. True or false value.

pub fn set_skip_destination_validation(self, input: Option<bool>) -> Self

Skips validation of Amazon SQS, Amazon SNS, and Lambda destinations. True or false value.

Trait Implementations

impl Clone for PutBucketNotificationConfiguration

fn clone(&self) -> PutBucketNotificationConfiguration

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for PutBucketNotificationConfiguration

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.