Skip to content

aws.s3.get_bucket_notification_configuration

Example SQL Queries

SELECT * FROM
aws.s3.get_bucket_notification_configuration
WHERE
"bucket" = 'VALUE';

Description

This operation is not supported by 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:

Table Definition

Column NameColumn Data Type
bucket Required Input Column

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.

VARCHAR
expected_bucket_owner Input Column

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

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
"type" VARCHAR,
"name" VARCHAR,
"account_id" VARCHAR,
"via_profile_name" VARCHAR,
"assumed_role_arn" VARCHAR,
"organization" STRUCT(
"account_name" VARCHAR,
"id" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[],
"master_account" STRUCT(
"id" VARCHAR,
"email" VARCHAR
),
"parents" STRUCT(
"type" VARCHAR,
"id" VARCHAR,
"name" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[]
)[]
)
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

event_bridge_configuration

Enables delivery of events to Amazon EventBridge.

BOOLEAN
lambda_function_configurations

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

STRUCT(
"id" VARCHAR,
"lambda_function_arn" VARCHAR,
"events" VARCHAR[],
"filter" STRUCT(
"key" STRUCT(
"filter_rules" STRUCT(
"name" VARCHAR,
"value" VARCHAR
)[]
)
)
)[]
Show child fields
lambda_function_configurations[]
Show child fields
lambda_function_configurations[].events[]
lambda_function_configurations[].filter

Specifies object key name filtering rules. For information about key name filtering, see Configuring event notifications using object key name filtering in the Amazon S3 User Guide.

Show child fields
lambda_function_configurations[].filter.key

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

Show child fields
lambda_function_configurations[].filter.key.filter_rules[]
Show child fields
lambda_function_configurations[].filter.key.filter_rules[].name

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 S3 User Guide.

lambda_function_configurations[].filter.key.filter_rules[].value

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

lambda_function_configurations[].id

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

lambda_function_configurations[].lambda_function_arn

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

queue_configurations

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

STRUCT(
"id" VARCHAR,
"queue_arn" VARCHAR,
"events" VARCHAR[],
"filter" STRUCT(
"key" STRUCT(
"filter_rules" STRUCT(
"name" VARCHAR,
"value" VARCHAR
)[]
)
)
)[]
Show child fields
queue_configurations[]
Show child fields
queue_configurations[].events[]
queue_configurations[].filter

Specifies object key name filtering rules. For information about key name filtering, see Configuring event notifications using object key name filtering in the Amazon S3 User Guide.

Show child fields
queue_configurations[].filter.key

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

Show child fields
queue_configurations[].filter.key.filter_rules[]
Show child fields
queue_configurations[].filter.key.filter_rules[].name

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 S3 User Guide.

queue_configurations[].filter.key.filter_rules[].value

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

queue_configurations[].id

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

queue_configurations[].queue_arn

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.

topic_configurations

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

STRUCT(
"id" VARCHAR,
"topic_arn" VARCHAR,
"events" VARCHAR[],
"filter" STRUCT(
"key" STRUCT(
"filter_rules" STRUCT(
"name" VARCHAR,
"value" VARCHAR
)[]
)
)
)[]
Show child fields
topic_configurations[]
Show child fields
topic_configurations[].events[]
topic_configurations[].filter

Specifies object key name filtering rules. For information about key name filtering, see Configuring event notifications using object key name filtering in the Amazon S3 User Guide.

Show child fields
topic_configurations[].filter.key

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

Show child fields
topic_configurations[].filter.key.filter_rules[]
Show child fields
topic_configurations[].filter.key.filter_rules[].name

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 S3 User Guide.

topic_configurations[].filter.key.filter_rules[].value

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

topic_configurations[].id

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

topic_configurations[].topic_arn

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.