| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.S3.GetBucketNotificationConfiguration
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:
Synopsis
- data GetBucketNotificationConfiguration = GetBucketNotificationConfiguration' {}
- newGetBucketNotificationConfiguration :: BucketName -> GetBucketNotificationConfiguration
- getBucketNotificationConfiguration_expectedBucketOwner :: Lens' GetBucketNotificationConfiguration (Maybe Text)
- getBucketNotificationConfiguration_bucket :: Lens' GetBucketNotificationConfiguration BucketName
- data NotificationConfiguration = NotificationConfiguration' {}
- newNotificationConfiguration :: NotificationConfiguration
- notificationConfiguration_queueConfigurations :: Lens' NotificationConfiguration (Maybe [QueueConfiguration])
- notificationConfiguration_topicConfigurations :: Lens' NotificationConfiguration (Maybe [TopicConfiguration])
- notificationConfiguration_lambdaFunctionConfigurations :: Lens' NotificationConfiguration (Maybe [LambdaFunctionConfiguration])
Creating a Request
data GetBucketNotificationConfiguration Source #
See: newGetBucketNotificationConfiguration smart constructor.
Constructors
| GetBucketNotificationConfiguration' | |
Fields
| |
Instances
newGetBucketNotificationConfiguration Source #
Arguments
| :: BucketName | |
| -> GetBucketNotificationConfiguration |
Create a value of GetBucketNotificationConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:expectedBucketOwner:GetBucketNotificationConfiguration', getBucketNotificationConfiguration_expectedBucketOwner - 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.
$sel:bucket:GetBucketNotificationConfiguration', getBucketNotificationConfiguration_bucket - The name of the bucket for which to get the notification configuration.
Request Lenses
getBucketNotificationConfiguration_expectedBucketOwner :: Lens' GetBucketNotificationConfiguration (Maybe Text) Source #
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.
getBucketNotificationConfiguration_bucket :: Lens' GetBucketNotificationConfiguration BucketName Source #
The name of the bucket for which to get the notification configuration.
Destructuring the Response
data NotificationConfiguration Source #
A container for specifying the notification configuration of the bucket. If this element is empty, notifications are turned off for the bucket.
See: newNotificationConfiguration smart constructor.
Constructors
| NotificationConfiguration' | |
Fields
| |
Instances
newNotificationConfiguration :: NotificationConfiguration Source #
Create a value of NotificationConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:queueConfigurations:NotificationConfiguration', notificationConfiguration_queueConfigurations - The Amazon Simple Queue Service queues to publish messages to and the
events for which to publish messages.
$sel:topicConfigurations:NotificationConfiguration', notificationConfiguration_topicConfigurations - The topic to which notifications are sent and the events for which
notifications are generated.
$sel:lambdaFunctionConfigurations:NotificationConfiguration', notificationConfiguration_lambdaFunctionConfigurations - Describes the Lambda functions to invoke and the events for which to
invoke them.
Response Lenses
notificationConfiguration_queueConfigurations :: Lens' NotificationConfiguration (Maybe [QueueConfiguration]) Source #
The Amazon Simple Queue Service queues to publish messages to and the events for which to publish messages.
notificationConfiguration_topicConfigurations :: Lens' NotificationConfiguration (Maybe [TopicConfiguration]) Source #
The topic to which notifications are sent and the events for which notifications are generated.
notificationConfiguration_lambdaFunctionConfigurations :: Lens' NotificationConfiguration (Maybe [LambdaFunctionConfiguration]) Source #
Describes the Lambda functions to invoke and the events for which to invoke them.