Skip to content

Commit a5d87c0

Browse files
author
Michael Brewer
committed
docs(data-classes): Correct docs
1 parent ecf8ba0 commit a5d87c0

File tree

2 files changed

+7
-3
lines changed

2 files changed

+7
-3
lines changed

aws_lambda_powertools/utilities/data_classes/s3_object_event.py

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ class S3ObjectContext(DictWrapper):
99
@property
1010
def input_s3_url(self) -> str:
1111
"""A pre-signed URL that can be used to fetch the original object from Amazon S3.
12+
1213
The URL is signed using the original caller’s identity, and their permissions
1314
will apply when the URL is used. If there are signed headers in the URL, the
1415
Lambda function must include these in the call to Amazon S3, except for the Host."""
@@ -45,6 +46,7 @@ def supporting_access_point_arn(self) -> str:
4546
@property
4647
def payload(self) -> str:
4748
"""Custom data that is applied to the S3 Object Lambda access point configuration.
49+
4850
S3 Object Lambda treats this as an opaque string, so it might need to be decoded
4951
before use."""
5052
return self["payload"]
@@ -138,7 +140,7 @@ def session_issuer(self) -> S3ObjectSessionIssuer:
138140

139141
@property
140142
def attributes(self) -> S3ObjectSessionAttributes:
141-
"""User session attributes. """
143+
"""Session attributes."""
142144
return S3ObjectSessionAttributes(self["attributes"])
143145

144146

@@ -176,6 +178,7 @@ def get_type(self) -> str:
176178
@property
177179
def account_id(self) -> str:
178180
"""The account that owns the entity that granted permissions for the request.
181+
179182
If the request was made with temporary security credentials, this is the account that owns the IAM
180183
user or role that was used to obtain credentials."""
181184
return self["accountId"]
@@ -222,7 +225,7 @@ def session_context(self) -> Optional[S3ObjectSessionContext]:
222225

223226

224227
class S3ObjectLambdaEvent(DictWrapper):
225-
"""S3 object event notification
228+
"""S3 object lambda event
226229
227230
Documentation:
228231
-------------

docs/utilities/data_classes.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -554,7 +554,8 @@ This example is based on the AWS Blog post [Introducing Amazon S3 Object Lambda
554554

555555
=== "app.py"
556556

557-
```python hl_lines="4 8 10"
557+
```python hl_lines="5 9 11"
558+
import boto3
558559
import requests
559560
from aws_lambda_powertools import Logger
560561
from aws_lambda_powertools.logging.correlation_paths import S3_OBJECT_LAMBDA

0 commit comments

Comments
 (0)