[ aws . s3api ]

get-bucket-notification-configuration

Description

Returns the notification configuration of a bucket.

If notifications are not enabled on the bucket, the action returns an empty NotificationConfiguration element.

By default, you must be the bucket owner to read the notification configuration of a bucket. However, the bucket owner can use a bucket policy to grant permission to other users to read this configuration with the s3:GetBucketNotification permission.

For more information about setting and reading the notification configuration on a bucket, see Setting Up Notification of Bucket Events . For more information about bucket policies, see Using Bucket Policies .

The following action is related to GetBucketNotification :

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  get-bucket-notification-configuration
--bucket <value>
[--expected-bucket-owner <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--bucket (string)

The name of the bucket for which to get the notification configuration.

--expected-bucket-owner (string)

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Examples

The following command retrieves the notification configuration for a bucket named my-bucket:

aws s3api get-bucket-notification-configuration --bucket my-bucket

Output:

{
    "TopicConfigurations": [
        {
            "Id": "YmQzMmEwM2EjZWVlI0NGItNzVtZjI1MC00ZjgyLWZDBiZWNl",
            "TopicArn": "arn:aws:sns:us-west-2:123456789012:my-notification-topic",
            "Events": [
                "s3:ObjectCreated:*"
            ]
        }
    ]
}

Output

TopicConfigurations -> (list)

The topic to which notifications are sent and the events for which notifications are generated.

(structure)

A container for specifying the configuration for publication of messages to an Amazon Simple Notification Service (Amazon SNS) topic when Amazon S3 detects specified events.

Id -> (string)

An optional unique identifier for configurations in a notification configuration. If you don’t provide one, Amazon S3 will assign an ID.

TopicArn -> (string)

The Amazon Resource Name (ARN) of the Amazon SNS topic to which Amazon S3 publishes a message when it detects events of the specified type.

Events -> (list)

The Amazon S3 bucket event about which to send notifications. For more information, see Supported Event Types in the Amazon Simple Storage Service User Guide .

(string)

The bucket event for which to send notifications.

Filter -> (structure)

Specifies object key name filtering rules. For information about key name filtering, see Configuring Event Notifications in the Amazon Simple Storage Service Developer Guide .

Key -> (structure)

A container for object key name prefix and suffix filtering rules.

FilterRules -> (list)

A list of containers for the key-value pair that defines the criteria for the filter rule.

(structure)

Specifies the Amazon S3 object key name to filter on and whether to filter on the suffix or prefix of the key name.

Name -> (string)

The object key name prefix or suffix identifying one or more objects to which the filtering rule applies. The maximum length is 1,024 characters. Overlapping prefixes and suffixes are not supported. For more information, see Configuring Event Notifications in the Amazon Simple Storage Service Developer Guide .

Value -> (string)

The value that the filter searches for in object key names.

QueueConfigurations -> (list)

The Amazon Simple Queue Service queues to publish messages to and the events for which to publish messages.

(structure)

Specifies the configuration for publishing messages to an Amazon Simple Queue Service (Amazon SQS) queue when Amazon S3 detects specified events.

Id -> (string)

An optional unique identifier for configurations in a notification configuration. If you don’t provide one, Amazon S3 will assign an ID.

QueueArn -> (string)

The Amazon Resource Name (ARN) of the Amazon SQS queue to which Amazon S3 publishes a message when it detects events of the specified type.

Events -> (list)

A collection of bucket events for which to send notifications

(string)

The bucket event for which to send notifications.

Filter -> (structure)

Specifies object key name filtering rules. For information about key name filtering, see Configuring Event Notifications in the Amazon Simple Storage Service Developer Guide .

Key -> (structure)

A container for object key name prefix and suffix filtering rules.

FilterRules -> (list)

A list of containers for the key-value pair that defines the criteria for the filter rule.

(structure)

Specifies the Amazon S3 object key name to filter on and whether to filter on the suffix or prefix of the key name.

Name -> (string)

The object key name prefix or suffix identifying one or more objects to which the filtering rule applies. The maximum length is 1,024 characters. Overlapping prefixes and suffixes are not supported. For more information, see Configuring Event Notifications in the Amazon Simple Storage Service Developer Guide .

Value -> (string)

The value that the filter searches for in object key names.

LambdaFunctionConfigurations -> (list)

Describes the AWS Lambda functions to invoke and the events for which to invoke them.

(structure)

A container for specifying the configuration for AWS Lambda notifications.

Id -> (string)

An optional unique identifier for configurations in a notification configuration. If you don’t provide one, Amazon S3 will assign an ID.

LambdaFunctionArn -> (string)

The Amazon Resource Name (ARN) of the AWS Lambda function that Amazon S3 invokes when the specified event type occurs.

Events -> (list)

The Amazon S3 bucket event for which to invoke the AWS Lambda function. For more information, see Supported Event Types in the Amazon Simple Storage Service Developer Guide .

(string)

The bucket event for which to send notifications.

Filter -> (structure)

Specifies object key name filtering rules. For information about key name filtering, see Configuring Event Notifications in the Amazon Simple Storage Service Developer Guide .

Key -> (structure)

A container for object key name prefix and suffix filtering rules.

FilterRules -> (list)

A list of containers for the key-value pair that defines the criteria for the filter rule.

(structure)

Specifies the Amazon S3 object key name to filter on and whether to filter on the suffix or prefix of the key name.

Name -> (string)

The object key name prefix or suffix identifying one or more objects to which the filtering rule applies. The maximum length is 1,024 characters. Overlapping prefixes and suffixes are not supported. For more information, see Configuring Event Notifications in the Amazon Simple Storage Service Developer Guide .

Value -> (string)

The value that the filter searches for in object key names.