feat(data-classes): Add S3 Object Lambda Event

[michaelbrewer]

Issue #, if available:

Description of changes:

Add data class for Amazon S3 Object Lambda

Example usage based on the AWS Blog Post on S3 Object Lambda

import requests
from aws_lambda_powertools import Logger
from aws_lambda_powertools.logging.correlation_paths import S3_OBJECT_LAMBDA
from aws_lambda_powertools.utilities.data_classes.s3_object_event import S3ObjectLambdaEvent

logger = Logger()

@logger.inject_lambda_context(correlation_id_path=S3_OBJECT_LAMBDA, log_event=True)
def lambda_handler(event, context):
    event = S3ObjectLambdaEvent(event)

    object_context = event.object_context
    request_route = object_context.output_route
    request_token = object_context.output_token
    s3_url = object_context.input_s3_url

    # Get object from S3
    response = requests.get(s3_url)
    original_object = response.content.decode("utf-8")

    # Transform object
    transformed_object = original_object.upper()

    # Write object back to S3 Object Lambda
    s3 = boto3.client("s3")
    s3.write_get_object_response(Body=transformed_object, RequestRoute=request_route, RequestToken=request_token)

    return {"status_code": 200}

Checklist

• Meet tenets criteria
• Update tests
• Update docs
• PR title follows conventional commit semantics

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

[codecov-io]

Codecov Report

Merging #353 (a5d87c0) into develop (961b25e) will decrease coverage by 0.05%.
The diff coverage is 100.00%.

@@             Coverage Diff             @@
##           develop     #353      +/-   ##
===========================================
- Coverage    99.88%   99.83%   -0.06%     
===========================================
  Files           95       96       +1     
  Lines         3529     3635     +106     
  Branches       173      174       +1     
===========================================
+ Hits          3525     3629     +104     
- Misses           2        4       +2     
  Partials         2        2              

Impacted Files	Coverage Δ
aws_lambda_powertools/logging/correlation_paths.py	100.00% <100.00%> (ø)
...wertools/utilities/data_classes/s3_object_event.py	100.00% <100.00%> (ø)
aws_lambda_powertools/utilities/parser/types.py	71.42% <0.00%> (-28.58%)	⬇️

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 961b25e...a5d87c0. Read the comment docs.

[michaelbrewer]

@heitorlessa still need to add S3ObjectSessionContext class potentially, I just wanted to check if this was something reusable as it would also help with CloudTrail event logs processing

[heitorlessa]

This is awesome and so timely - added one major ask and a nitpick

[heitorlessa]

On the readability thing, I need to get my laptop to take a proper look - We can do on Monday (your morning) as part of an experimental office hours

I'm all for reusing as long as UX doesn't confuse S3 Object with S3 Object Lambda (naming challenging that will confuse for sure)

[heitorlessa]

Let’s discuss some ideas on Monday ;)

…

On Sat, 20 Mar 2021 at 19:43, Michael Brewer ***@***.***> wrote: ***@***.**** commented on this pull request. ------------------------------ In aws_lambda_powertools/utilities/data_classes/s3_event.py <#353 (comment)> : > + @Property + def arn(self) -> str: + """The ARN of the principal that made the call. + The last section of the ARN contains the user or role that made the call.""" + return self["arn"] + + @Property + def session_context(self) -> Optional[Dict[str, Any]]: + """ If the request was made with temporary security credentials, + this element provides information about the session that was created for those credentials.""" + return self.get("sessionContext") + + +class S3ObjectEvent(DictWrapper): + """S3 object event notification + @heitorlessa <https://github.com/heitorlessa> I do have it in the data_classes.md but I can see how to do it in general for data-classes package? — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#353 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAZPQBCHC4F3UY34HBDDMOTTETUFLANCNFSM4ZQRRXMA> .

[heitorlessa]

Is correlation path S3_OBJECT or supposed to be S3_OBJECT_LAMBDA?

[heitorlessa]

two suggestions to make this feature and docs even more awesome ;)

[heitorlessa]

Example of UX with these additional changes ;)

They could also be methods, I don't mind either way works as long as we make this as easy as possible to customers as we know the common use cases already

[michaelbrewer]

@heitorlessa quick question why request_route over output_route for the name?

[heitorlessa]

The name was to match SDK params

…

On Mon, 22 Mar 2021 at 18:07, Michael Brewer ***@***.***> wrote: @michaelbrewer <https://github.com/michaelbrewer> requested your review on: #353 <#353> feat(data-classes): Add S3 Object Lambda Event. — You are receiving this because your review was requested. Reply to this email directly, view it on GitHub <#353 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAZPQBDGQ7SMZOEJ6YT5T23TE52L7ANCNFSM4ZQRRXMA> .

[heitorlessa]

@heitorlessa quick question why request_route over output_route for the name?

That's to match writer get object response params - RequestRoute & RequestToken.

When you're writing now you'll instinctively look up the event to find these, and they'll find them now effortlessly to comply with the SDK ;-)

[heitorlessa]

Thanks a lot for the super timely addition ;-)

Will release it this week