Amazonka.S3.GetBucketNotificationConfiguration

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:

• PutBucketNotification

Creating a Request

data GetBucketNotificationConfiguration

See: newGetBucketNotificationConfiguration smart constructor.

Constructors

GetBucketNotificationConfiguration'

Fields

• expectedBucketOwner :: Maybe Text

  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).

• bucket :: BucketName

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

Instances

ToHeaders GetBucketNotificationConfiguration

Defined in Amazonka.S3.GetBucketNotificationConfiguration

Methods

toHeaders :: GetBucketNotificationConfiguration -> [Header]

ToPath GetBucketNotificationConfiguration

Defined in Amazonka.S3.GetBucketNotificationConfiguration

Methods

toPath :: GetBucketNotificationConfiguration -> ByteString

ToQuery GetBucketNotificationConfiguration

Defined in Amazonka.S3.GetBucketNotificationConfiguration

Methods

toQuery :: GetBucketNotificationConfiguration -> QueryString

AWSRequest GetBucketNotificationConfiguration

Defined in Amazonka.S3.GetBucketNotificationConfiguration

Associated Types

type AWSResponse GetBucketNotificationConfiguration

Methods

request :: (Service -> Service) -> GetBucketNotificationConfiguration -> Request GetBucketNotificationConfiguration

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetBucketNotificationConfiguration -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetBucketNotificationConfiguration)))

Generic GetBucketNotificationConfiguration

Defined in Amazonka.S3.GetBucketNotificationConfiguration

Associated Types

type Rep GetBucketNotificationConfiguration :: Type -> Type

Methods

from :: GetBucketNotificationConfiguration -> Rep GetBucketNotificationConfiguration x

to :: Rep GetBucketNotificationConfiguration x -> GetBucketNotificationConfiguration

Read GetBucketNotificationConfiguration

Defined in Amazonka.S3.GetBucketNotificationConfiguration

Methods

readsPrec :: Int -> ReadS GetBucketNotificationConfiguration

readList :: ReadS [GetBucketNotificationConfiguration]

readPrec :: ReadPrec GetBucketNotificationConfiguration

readListPrec :: ReadPrec [GetBucketNotificationConfiguration]

Show GetBucketNotificationConfiguration

Defined in Amazonka.S3.GetBucketNotificationConfiguration

Methods

showsPrec :: Int -> GetBucketNotificationConfiguration -> ShowS

show :: GetBucketNotificationConfiguration -> String

showList :: [GetBucketNotificationConfiguration] -> ShowS

NFData GetBucketNotificationConfiguration

Defined in Amazonka.S3.GetBucketNotificationConfiguration

Methods

rnf :: GetBucketNotificationConfiguration -> ()

Eq GetBucketNotificationConfiguration

Defined in Amazonka.S3.GetBucketNotificationConfiguration

Methods

(==) :: GetBucketNotificationConfiguration -> GetBucketNotificationConfiguration -> Bool

(/=) :: GetBucketNotificationConfiguration -> GetBucketNotificationConfiguration -> Bool

Hashable GetBucketNotificationConfiguration

Defined in Amazonka.S3.GetBucketNotificationConfiguration

Methods

hashWithSalt :: Int -> GetBucketNotificationConfiguration -> Int

hash :: GetBucketNotificationConfiguration -> Int

type AWSResponse GetBucketNotificationConfiguration

Defined in Amazonka.S3.GetBucketNotificationConfiguration

type AWSResponse GetBucketNotificationConfiguration = NotificationConfiguration

type Rep GetBucketNotificationConfiguration

Defined in Amazonka.S3.GetBucketNotificationConfiguration

type Rep GetBucketNotificationConfiguration = D1 ('MetaData "GetBucketNotificationConfiguration" "Amazonka.S3.GetBucketNotificationConfiguration" "amazonka-s3-2.0-CNZtv1UmVzj28JXsFvwNoj" 'False) (C1 ('MetaCons "GetBucketNotificationConfiguration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "expectedBucketOwner") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "bucket") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 BucketName)))

newGetBucketNotificationConfiguration

Arguments

:: BucketName

GetBucketNotificationConfiguration

-> 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 fails with the HTTP status code 403 Forbidden (access denied).

GetBucketNotificationConfiguration, getBucketNotificationConfiguration_bucket - The name of the bucket for which to get the notification configuration.

Request Lenses

getBucketNotificationConfiguration_expectedBucketOwner :: Lens' GetBucketNotificationConfiguration (Maybe Text)

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).

getBucketNotificationConfiguration_bucket :: Lens' GetBucketNotificationConfiguration BucketName

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

Destructuring the Response

data NotificationConfiguration

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

• eventBridgeConfiguration :: Maybe EventBridgeConfiguration

  Enables delivery of events to Amazon EventBridge.

• lambdaFunctionConfigurations :: Maybe [LambdaFunctionConfiguration]

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

• queueConfigurations :: Maybe [QueueConfiguration]

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

• topicConfigurations :: Maybe [TopicConfiguration]

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

Instances

FromXML NotificationConfiguration

Defined in Amazonka.S3.Types.NotificationConfiguration

Methods

parseXML :: [Node] -> Either String NotificationConfiguration

ToXML NotificationConfiguration

Defined in Amazonka.S3.Types.NotificationConfiguration

Methods

toXML :: NotificationConfiguration -> XML

Generic NotificationConfiguration

Defined in Amazonka.S3.Types.NotificationConfiguration

Associated Types

type Rep NotificationConfiguration :: Type -> Type

Methods

from :: NotificationConfiguration -> Rep NotificationConfiguration x

to :: Rep NotificationConfiguration x -> NotificationConfiguration

Read NotificationConfiguration

Defined in Amazonka.S3.Types.NotificationConfiguration

Methods

readsPrec :: Int -> ReadS NotificationConfiguration

readList :: ReadS [NotificationConfiguration]

readPrec :: ReadPrec NotificationConfiguration

readListPrec :: ReadPrec [NotificationConfiguration]

Show NotificationConfiguration

Defined in Amazonka.S3.Types.NotificationConfiguration

Methods

showsPrec :: Int -> NotificationConfiguration -> ShowS

show :: NotificationConfiguration -> String

showList :: [NotificationConfiguration] -> ShowS

NFData NotificationConfiguration

Defined in Amazonka.S3.Types.NotificationConfiguration

Methods

rnf :: NotificationConfiguration -> ()

Eq NotificationConfiguration

Defined in Amazonka.S3.Types.NotificationConfiguration

Methods

(==) :: NotificationConfiguration -> NotificationConfiguration -> Bool

(/=) :: NotificationConfiguration -> NotificationConfiguration -> Bool

Hashable NotificationConfiguration

Defined in Amazonka.S3.Types.NotificationConfiguration

Methods

hashWithSalt :: Int -> NotificationConfiguration -> Int

hash :: NotificationConfiguration -> Int

type Rep NotificationConfiguration

Defined in Amazonka.S3.Types.NotificationConfiguration

type Rep NotificationConfiguration = D1 ('MetaData "NotificationConfiguration" "Amazonka.S3.Types.NotificationConfiguration" "amazonka-s3-2.0-CNZtv1UmVzj28JXsFvwNoj" 'False) (C1 ('MetaCons "NotificationConfiguration'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "eventBridgeConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EventBridgeConfiguration)) :*: S1 ('MetaSel ('Just "lambdaFunctionConfigurations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [LambdaFunctionConfiguration]))) :*: (S1 ('MetaSel ('Just "queueConfigurations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [QueueConfiguration])) :*: S1 ('MetaSel ('Just "topicConfigurations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [TopicConfiguration])))))

newNotificationConfiguration :: NotificationConfiguration

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:eventBridgeConfiguration:NotificationConfiguration', notificationConfiguration_eventBridgeConfiguration - Enables delivery of events to Amazon EventBridge.

$sel:lambdaFunctionConfigurations:NotificationConfiguration', notificationConfiguration_lambdaFunctionConfigurations - Describes the Lambda functions to invoke and the events for which to invoke them.

$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.

Response Lenses

notificationConfiguration_eventBridgeConfiguration :: Lens' NotificationConfiguration (Maybe EventBridgeConfiguration)

Enables delivery of events to Amazon EventBridge.

notificationConfiguration_lambdaFunctionConfigurations :: Lens' NotificationConfiguration (Maybe [LambdaFunctionConfiguration])

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

notificationConfiguration_queueConfigurations :: Lens' NotificationConfiguration (Maybe [QueueConfiguration])

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

notificationConfiguration_topicConfigurations :: Lens' NotificationConfiguration (Maybe [TopicConfiguration])

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