Skip to content

Commit 0cc72f0

Browse files
Improve documentation
1 parent d814aba commit 0cc72f0

2 files changed

Lines changed: 17 additions & 4 deletions

File tree

aws_lambda_powertools/utilities/typing/lambda_context.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -76,12 +76,12 @@ def log_stream_name(self) -> str:
7676

7777
@property
7878
def identity(self) -> LambdaCognitoIdentity:
79-
"""(mobile apps) Information about the Amazon Cognito identity that authorized the request."""
79+
"""Information about the Amazon Cognito identity that authorized the request."""
8080
return self._identity
8181

8282
@property
8383
def client_context(self) -> LambdaClientContext:
84-
"""(mobile apps) Client context that's provided to Lambda by the client application."""
84+
"""Client context that's provided to Lambda by the client application."""
8585
return self._client_context
8686

8787
@property

docs/utilities/typing.md

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -42,5 +42,18 @@ Using `LambdaContext` typing makes it possible to access information and hints o
4242
--8<-- "examples/typing/src/working_with_context_function.py"
4343
```
4444

45-
![Utilities Typing All](../media/utilities_typing_2.png)
46-
![Utilities Typing Specific](../media/utilities_typing_3.png)
45+
### Available properties and methods
46+
47+
| Name | Type | Description |
48+
| ------------------------------ | -------- | ------------------------------------------------------------------------- |
49+
| `function_name` | property | The name of the Lambda function |
50+
| `function_version` | property | The version of the function |
51+
| `invoked_function_arn` | property | The Amazon Resource Name (ARN) that's used to invoke the function |
52+
| `memory_limit_in_mb` | property | The amount of memory that's allocated for the function |
53+
| `aws_request_id` | property | The identifier of the invocation request |
54+
| `log_group_name` | property | The log group for the function |
55+
| `log_stream_name` | property | The log stream for the function instance |
56+
| `identity` | property | Information about the Amazon Cognito identity that authorized the request |
57+
| `client_context` | property | Client context that's provided to Lambda by the client application |
58+
| `tenant_id` | property | The tenant_id used to invoke the function |
59+
| `get_remaining_time_in_millis` | method | Returns the number of milliseconds left before the execution times out |

0 commit comments

Comments
 (0)