get_bucket_notification_configuration¶
Operation¶
get_bucket_notification_configuration
async
¶
get_bucket_notification_configuration(request: GetBucketNotificationConfigurationInput | GetBucketNotificationConfigurationInputDict, /, *, plugins: list[Plugin] | None = None) -> GetBucketNotificationConfigurationOutput
get_bucket_notification_configuration(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetBucketNotificationConfigurationInputDict]) -> GetBucketNotificationConfigurationOutput
Note
This operation is not supported for directory buckets.
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.
When you use this API operation with an access point, provide the alias of the access point in place of the bucket name.
When you use this API operation with an Object Lambda access point,
provide the alias of the Object Lambda access point in place of the
bucket name. If the Object Lambda access point alias in a request is not
valid, the error code InvalidAccessPointAliasError is returned. For
more information about InvalidAccessPointAliasError, see List of
Error
Codes.
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:
Warning
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.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
Returns:
| Type | Description |
|---|---|
GetBucketNotificationConfigurationOutput
|
An instance of |
Input¶
Pass the input fields as keyword arguments, or pass a model or dictionary as the first positional argument. Pass plugins separately as a keyword argument.
Model¶
GetBucketNotificationConfigurationInput
dataclass
¶
Bases: _SerdeShape
Dataclass for GetBucketNotificationConfigurationInput structure.
Attributes¶
bucket
class-attribute
instance-attribute
¶
bucket: str | None = ...
The name of the bucket for which to get the notification configuration.
When you use this API operation with an access point, provide the alias of the access point in place of the bucket name.
When you use this API operation with an Object Lambda access point,
provide the alias of the Object Lambda access point in place of the
bucket name. If the Object Lambda access point alias in a request is not
valid, the error code InvalidAccessPointAliasError is returned. For
more information about InvalidAccessPointAliasError, see List of
Error
Codes.
expected_bucket_owner
class-attribute
instance-attribute
¶
expected_bucket_owner: str | None = ...
The account ID of the expected bucket owner. If the account ID that you
provide does not match the actual owner of the bucket, the request fails
with the HTTP status code 403 Forbidden (access denied).
Dictionaries¶
GetBucketNotificationConfigurationInputDict
¶
Bases: TypedDict
Dictionary form of GetBucketNotificationConfigurationInput.
Attributes¶
bucket
instance-attribute
¶
The name of the bucket for which to get the notification configuration.
When you use this API operation with an access point, provide the alias of the access point in place of the bucket name.
When you use this API operation with an Object Lambda access point,
provide the alias of the Object Lambda access point in place of the
bucket name. If the Object Lambda access point alias in a request is not
valid, the error code InvalidAccessPointAliasError is returned. For
more information about InvalidAccessPointAliasError, see List of
Error
Codes.
Output¶
GetBucketNotificationConfigurationOutput
dataclass
¶
Bases: _SerdeShape
A container for specifying the notification configuration of the bucket. If this element is empty, notifications are turned off for the bucket.
Attributes¶
event_bridge_configuration
class-attribute
instance-attribute
¶
event_bridge_configuration: EventBridgeConfiguration | None = ...
Enables delivery of events to Amazon EventBridge.
lambda_function_configurations
class-attribute
instance-attribute
¶
lambda_function_configurations: list[LambdaFunctionConfiguration] | None = ...
Describes the Lambda functions to invoke and the events for which to invoke them.
queue_configurations
class-attribute
instance-attribute
¶
queue_configurations: list[QueueConfiguration] | None = ...
The Amazon Simple Queue Service queues to publish messages to and the events for which to publish messages.
response_metadata
class-attribute
instance-attribute
¶
Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.
topic_configurations
class-attribute
instance-attribute
¶
topic_configurations: list[TopicConfiguration] | None = ...
The topic to which notifications are sent and the events for which notifications are generated.