Skip to content

Commit

Permalink
docs(data-classes): Correct docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Michael Brewer committed Mar 21, 2021
1 parent ecf8ba0 commit a5d87c0
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 3 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ class S3ObjectContext(DictWrapper):
@property
def input_s3_url(self) -> str:
"""A pre-signed URL that can be used to fetch the original object from Amazon S3.
The URL is signed using the original caller’s identity, and their permissions
will apply when the URL is used. If there are signed headers in the URL, the
Lambda function must include these in the call to Amazon S3, except for the Host."""
Expand Down Expand Up @@ -45,6 +46,7 @@ def supporting_access_point_arn(self) -> str:
@property
def payload(self) -> str:
"""Custom data that is applied to the S3 Object Lambda access point configuration.
S3 Object Lambda treats this as an opaque string, so it might need to be decoded
before use."""
return self["payload"]
Expand Down Expand Up @@ -138,7 +140,7 @@ def session_issuer(self) -> S3ObjectSessionIssuer:

@property
def attributes(self) -> S3ObjectSessionAttributes:
"""User session attributes. """
"""Session attributes."""
return S3ObjectSessionAttributes(self["attributes"])


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


class S3ObjectLambdaEvent(DictWrapper):
"""S3 object event notification
"""S3 object lambda event
Documentation:
-------------
Expand Down
3 changes: 2 additions & 1 deletion docs/utilities/data_classes.md
Original file line number Diff line number Diff line change
Expand Up @@ -554,7 +554,8 @@ This example is based on the AWS Blog post [Introducing Amazon S3 Object Lambda

=== "app.py"

```python hl_lines="4 8 10"
```python hl_lines="5 9 11"
import boto3
import requests
from aws_lambda_powertools import Logger
from aws_lambda_powertools.logging.correlation_paths import S3_OBJECT_LAMBDA
Expand Down

0 comments on commit a5d87c0

Please sign in to comment.