Class PutBucketNotificationConfigurationCommand

This operation is not supported for directory buckets.

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 the required 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.

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

You must URL encode any signed header values that contain spaces. For example, if your header value is my file.txt, containing two spaces after my, you must URL encode this value to my%20%20file.txt.

Example

Use a bare-bones client and the command you need to make an API call.

import { S3Client, PutBucketNotificationConfigurationCommand } from "ibm-cos-sdk-v2"; // ES Modules import
// const { S3Client, PutBucketNotificationConfigurationCommand } = require("ibm-cos-sdk-v2"); // CommonJS import
// import type { S3ClientConfig } from "ibm-cos-sdk-v2";
const config = {}; // type is S3ClientConfig
const client = new S3Client(config);
const input = { // PutBucketNotificationConfigurationRequest
  Bucket: "STRING_VALUE", // required
  NotificationConfiguration: { // NotificationConfiguration
    TopicConfigurations: [ // TopicConfigurationList
      { // TopicConfiguration
        Id: "STRING_VALUE",
        TopicArn: "STRING_VALUE", // required
        Events: [ // EventList // required
          "s3:ReducedRedundancyLostObject" || "s3:ObjectCreated:*" || "s3:ObjectCreated:Put" || "s3:ObjectCreated:Post" || "s3:ObjectCreated:Copy" || "s3:ObjectCreated:CompleteMultipartUpload" || "s3:ObjectRemoved:*" || "s3:ObjectRemoved:Delete" || "s3:ObjectRemoved:DeleteMarkerCreated" || "s3:ObjectRestore:*" || "s3:ObjectRestore:Post" || "s3:ObjectRestore:Completed" || "s3:Replication:*" || "s3:Replication:OperationFailedReplication" || "s3:Replication:OperationNotTracked" || "s3:Replication:OperationMissedThreshold" || "s3:Replication:OperationReplicatedAfterThreshold" || "s3:ObjectRestore:Delete" || "s3:LifecycleTransition" || "s3:IntelligentTiering" || "s3:ObjectAcl:Put" || "s3:LifecycleExpiration:*" || "s3:LifecycleExpiration:Delete" || "s3:LifecycleExpiration:DeleteMarkerCreated" || "s3:ObjectTagging:*" || "s3:ObjectTagging:Put" || "s3:ObjectTagging:Delete",
        ],
        Filter: { // NotificationConfigurationFilter
          Key: { // S3KeyFilter
            FilterRules: [ // FilterRuleList
              { // FilterRule
                Name: "prefix" || "suffix",
                Value: "STRING_VALUE",
              },
            ],
          },
        },
      },
    ],
    QueueConfigurations: [ // QueueConfigurationList
      { // QueueConfiguration
        Id: "STRING_VALUE",
        QueueArn: "STRING_VALUE", // required
        Events: [ // required
          "s3:ReducedRedundancyLostObject" || "s3:ObjectCreated:*" || "s3:ObjectCreated:Put" || "s3:ObjectCreated:Post" || "s3:ObjectCreated:Copy" || "s3:ObjectCreated:CompleteMultipartUpload" || "s3:ObjectRemoved:*" || "s3:ObjectRemoved:Delete" || "s3:ObjectRemoved:DeleteMarkerCreated" || "s3:ObjectRestore:*" || "s3:ObjectRestore:Post" || "s3:ObjectRestore:Completed" || "s3:Replication:*" || "s3:Replication:OperationFailedReplication" || "s3:Replication:OperationNotTracked" || "s3:Replication:OperationMissedThreshold" || "s3:Replication:OperationReplicatedAfterThreshold" || "s3:ObjectRestore:Delete" || "s3:LifecycleTransition" || "s3:IntelligentTiering" || "s3:ObjectAcl:Put" || "s3:LifecycleExpiration:*" || "s3:LifecycleExpiration:Delete" || "s3:LifecycleExpiration:DeleteMarkerCreated" || "s3:ObjectTagging:*" || "s3:ObjectTagging:Put" || "s3:ObjectTagging:Delete",
        ],
        Filter: {
          Key: {
            FilterRules: [
              {
                Name: "prefix" || "suffix",
                Value: "STRING_VALUE",
              },
            ],
          },
        },
      },
    ],
    LambdaFunctionConfigurations: [ // LambdaFunctionConfigurationList
      { // LambdaFunctionConfiguration
        Id: "STRING_VALUE",
        LambdaFunctionArn: "STRING_VALUE", // required
        Events: [ // required
          "s3:ReducedRedundancyLostObject" || "s3:ObjectCreated:*" || "s3:ObjectCreated:Put" || "s3:ObjectCreated:Post" || "s3:ObjectCreated:Copy" || "s3:ObjectCreated:CompleteMultipartUpload" || "s3:ObjectRemoved:*" || "s3:ObjectRemoved:Delete" || "s3:ObjectRemoved:DeleteMarkerCreated" || "s3:ObjectRestore:*" || "s3:ObjectRestore:Post" || "s3:ObjectRestore:Completed" || "s3:Replication:*" || "s3:Replication:OperationFailedReplication" || "s3:Replication:OperationNotTracked" || "s3:Replication:OperationMissedThreshold" || "s3:Replication:OperationReplicatedAfterThreshold" || "s3:ObjectRestore:Delete" || "s3:LifecycleTransition" || "s3:IntelligentTiering" || "s3:ObjectAcl:Put" || "s3:LifecycleExpiration:*" || "s3:LifecycleExpiration:Delete" || "s3:LifecycleExpiration:DeleteMarkerCreated" || "s3:ObjectTagging:*" || "s3:ObjectTagging:Put" || "s3:ObjectTagging:Delete",
        ],
        Filter: {
          Key: {
            FilterRules: [
              {
                Name: "prefix" || "suffix",
                Value: "STRING_VALUE",
              },
            ],
          },
        },
      },
    ],
    EventBridgeConfiguration: {},
  },
  ExpectedBucketOwner: "STRING_VALUE",
  SkipDestinationValidation: true || false,
};
const command = new PutBucketNotificationConfigurationCommand(input);
const response = await client.send(command);
// {};

Base exception class for all service exceptions from S3 service.

Example: Set notification configuration for a bucket

// The following example sets notification configuration on a bucket to publish the object created events to an SNS topic.
const input = {
  Bucket: "examplebucket",
  NotificationConfiguration: {
    TopicConfigurations: [
      {
        Events: [
          "s3:ObjectCreated:*"
        ],
        TopicArn: "arn:aws:sns:us-west-2:123456789012:s3-notification-topic"
      }
    ]
  }
};
const command = new PutBucketNotificationConfigurationCommand(input);
const response = await client.send(command);
/* response is
{ /* metadata only */ }
*/

Hierarchy

CommandImpl<
    PutBucketNotificationConfigurationCommandInput,
    PutBucketNotificationConfigurationCommandOutput,
    S3ClientResolvedConfig,
    ServiceInputTypes,
    ServiceOutputTypes,
    this,
>
- PutBucketNotificationConfigurationCommand

Index

Constructors

constructor

Constructors

constructor

new PutBucketNotificationConfigurationCommand(
input: PutBucketNotificationConfigurationCommandInput,
): PutBucketNotificationConfigurationCommand
Parameters
- input: PutBucketNotificationConfigurationCommandInput
Returns PutBucketNotificationConfigurationCommand
Inherited from $Command .classBuilder< PutBucketNotificationConfigurationCommandInput, PutBucketNotificationConfigurationCommandOutput, S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes >() .ep({ ...commonParams, UseS3ExpressControlEndpoint: { type: "staticContextParams", value: true }, Bucket: { type: "contextParams", name: "Bucket" }, }) .m(function (this: any, Command: any, cs: any, config: S3ClientResolvedConfig, o: any) { return [getEndpointPlugin(config, Command.getEndpointParameterInstructions())]; }) .s("AmazonS3", "PutBucketNotificationConfiguration", {}) .n("S3Client", "PutBucketNotificationConfigurationCommand") .sc(PutBucketNotificationConfiguration$) .build().constructor
- Defined in node_modules/@smithy/smithy-client/dist-types/command.d.ts:103
new PutBucketNotificationConfigurationCommand(
...__namedParameters: [PutBucketNotificationConfigurationCommandInput],
): PutBucketNotificationConfigurationCommand
Parameters
- ...__namedParameters: [PutBucketNotificationConfigurationCommandInput]
Returns PutBucketNotificationConfigurationCommand
Inherited from $Command .classBuilder< PutBucketNotificationConfigurationCommandInput, PutBucketNotificationConfigurationCommandOutput, S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes >() .ep({ ...commonParams, UseS3ExpressControlEndpoint: { type: "staticContextParams", value: true }, Bucket: { type: "contextParams", name: "Bucket" }, }) .m(function (this: any, Command: any, cs: any, config: S3ClientResolvedConfig, o: any) { return [getEndpointPlugin(config, Command.getEndpointParameterInstructions())]; }) .s("AmazonS3", "PutBucketNotificationConfiguration", {}) .n("S3Client", "PutBucketNotificationConfigurationCommand") .sc(PutBucketNotificationConfiguration$) .build().constructor
- Defined in node_modules/@smithy/smithy-client/dist-types/command.d.ts:104

Class PutBucketNotificationConfigurationCommand

Example

Param: PutBucketNotificationConfigurationCommandInput

Returns

See

Throws

Example: Set notification configuration for a bucket

Hierarchy

Index

Constructors

Constructors

constructor

Parameters

Returns PutBucketNotificationConfigurationCommand

Parameters

Returns PutBucketNotificationConfigurationCommand

Settings

On This Page