Skip to content

Commit f470143

Browse files
author
Michael Brewer
committed
refactor(data-classes): Rename S3ObjectEvent to S3ObjectLambdaEvent
1 parent 107d1d4 commit f470143

File tree

3 files changed

+8
-8
lines changed

3 files changed

+8
-8
lines changed

aws_lambda_powertools/utilities/data_classes/s3_event.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -348,7 +348,7 @@ def session_context(self) -> Optional[Dict[str, Any]]:
348348
return self.get("sessionContext")
349349

350350

351-
class S3ObjectEvent(DictWrapper):
351+
class S3ObjectLambdaEvent(DictWrapper):
352352
"""S3 object event notification
353353
354354
Documentation:

docs/utilities/data_classes.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ Event Source | Data_class
5959
[EventBridge](#eventbridge) | `EventBridgeEvent`
6060
[Kinesis Data Stream](#kinesis-streams) | `KinesisStreamEvent`
6161
[S3](#s3) | `S3Event`
62-
[S3 Object](#s3-object) | `S3ObjectEvent`
62+
[S3 Object Lambda](#s3-object-lambda) | `S3ObjectLambdaEvent`
6363
[SES](#ses) | `SESEvent`
6464
[SNS](#sns) | `SNSEvent`
6565
[SQS](#sqs) | `SQSEvent`
@@ -548,7 +548,7 @@ or plain text, depending on the original payload.
548548
do_something_with(f'{bucket_name}/{object_key}')
549549
```
550550

551-
### S3 Object
551+
### S3 Object Lambda
552552

553553
This example is based on the AWS Blog post [Introducing Amazon S3 Object Lambda – Use Your Code to Process Data as It Is Being Retrieved from S3](https://aws.amazon.com/blogs/aws/introducing-amazon-s3-object-lambda-use-your-code-to-process-data-as-it-is-being-retrieved-from-s3/){target="_blank"}.
554554

@@ -558,13 +558,13 @@ This example is based on the AWS Blog post [Introducing Amazon S3 Object Lambda
558558
import requests
559559
from aws_lambda_powertools import Logger
560560
from aws_lambda_powertools.logging.correlation_paths import S3_OBJECT
561-
from aws_lambda_powertools.utilities.data_classes.s3_event import S3ObjectEvent
561+
from aws_lambda_powertools.utilities.data_classes.s3_event import S3ObjectLambdaEvent
562562

563563
logger = Logger()
564564

565565
@logger.inject_lambda_context(correlation_id_path=S3_OBJECT, log_event=True)
566566
def lambda_handler(event, context):
567-
event = S3ObjectEvent(event)
567+
event = S3ObjectLambdaEvent(event)
568568

569569
object_context = event.object_context
570570
request_route = object_context.output_route

tests/functional/test_lambda_trigger_events.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@
4848
DynamoDBStreamEvent,
4949
StreamViewType,
5050
)
51-
from aws_lambda_powertools.utilities.data_classes.s3_event import S3ObjectEvent
51+
from aws_lambda_powertools.utilities.data_classes.s3_event import S3ObjectLambdaEvent
5252

5353

5454
def load_event(file_name: str) -> dict:
@@ -1009,7 +1009,7 @@ def test_appsync_resolver_event_empty():
10091009

10101010

10111011
def test_s3_object_event_iam():
1012-
event = S3ObjectEvent(load_event("s3ObjectEventIAMUser.json"))
1012+
event = S3ObjectLambdaEvent(load_event("s3ObjectEventIAMUser.json"))
10131013

10141014
assert event.request_id == "1a5ed718-5f53-471d-b6fe-5cf62d88d02a"
10151015
assert event.object_context is not None
@@ -1040,7 +1040,7 @@ def test_s3_object_event_iam():
10401040

10411041

10421042
def test_s3_object_event_temp_credentials():
1043-
event = S3ObjectEvent(load_event("s3ObjectEventTempCredentials.json"))
1043+
event = S3ObjectLambdaEvent(load_event("s3ObjectEventTempCredentials.json"))
10441044

10451045
assert event.request_id == "requestId"
10461046
session_context = event.user_identity.session_context

0 commit comments

Comments
 (0)