docs: Correct code examples (#317)

* docs: Correct code examples

Changes:
* Fix formatting for the api docs
* Correct the data classes code examples in the docs

* docs: Fix typo for sampling rate

Author: Michael Brewer

Diff for: aws_lambda_powertools/logging/logger.py

@@ -53,7 +53,7 @@ class Logger(logging.Logger):  # lgtm [py/missing-call-to-init]
     LOG_LEVEL: str
         logging level (e.g. INFO, DEBUG)
     POWERTOOLS_LOGGER_SAMPLE_RATE: float
-        samping rate ranging from 0 to 1, 1 being 100% sampling
+        sampling rate ranging from 0 to 1, 1 being 100% sampling
 
     Parameters
     ----------

Diff for: aws_lambda_powertools/middleware_factory/exceptions.py

@@ -1,4 +1,2 @@
 class MiddlewareInvalidArgumentError(Exception):
     """When middleware receives non keyword=arguments"""
-
-    pass

Diff for: aws_lambda_powertools/utilities/batch/base.py

@@ -125,6 +125,7 @@ def batch_processor(
     Examples
     --------
     **Processes Lambda's event with PartialSQSProcessor**
+
         >>> from aws_lambda_powertools.utilities.batch import batch_processor, PartialSQSProcessor
         >>>
         >>> def record_handler(record):

Diff for: aws_lambda_powertools/utilities/batch/sqs.py

@@ -53,6 +53,7 @@ class PartialSQSProcessor(BasePartialProcessor):
         >>>     # have been deleted from the queue after context's exit.
         >>>
         >>>     return result
+
     """
 
     def __init__(self, config: Optional[Config] = None, suppress_exception: bool = False):
@@ -163,10 +164,11 @@ def sqs_batch_processor(
     Examples
     --------
     **Processes Lambda's event with PartialSQSProcessor**
+
         >>> from aws_lambda_powertools.utilities.batch import sqs_batch_processor
         >>>
         >>> def record_handler(record):
-        >>>     return record["body"]
+        >>>      return record["body"]
         >>>
         >>> @sqs_batch_processor(record_handler=record_handler)
         >>> def handler(event, context):

Diff for: aws_lambda_powertools/utilities/idempotency/idempotency.py

@@ -51,6 +51,7 @@ def idempotent(
     Examples
     --------
     **Processes Lambda's event in an idempotent manner**
+
         >>> from aws_lambda_powertools.utilities.idempotency import (
         >>>    idempotent, DynamoDBPersistenceLayer, IdempotencyConfig
         >>> )

Diff for: aws_lambda_powertools/utilities/idempotency/persistence/dynamodb.py

@@ -53,11 +53,14 @@ def __init__(
         Examples
         --------
         **Create a DynamoDB persistence layer with custom settings**
-            >>> from aws_lambda_powertools.utilities.idempotency import idempotent, DynamoDBPersistenceLayer
+
+            >>> from aws_lambda_powertools.utilities.idempotency import (
+            >>>    idempotent, DynamoDBPersistenceLayer
+            >>> )
             >>>
             >>> persistence_store = DynamoDBPersistenceLayer(table_name="idempotency_store")
             >>>
-            >>> @idempotent(persistence_store=persistence_store, event_key="body")
+            >>> @idempotent(persistence_store=persistence_store)
             >>> def handler(event, context):
             >>>     return {"StatusCode": 200}
         """

Diff for: docs/utilities/data_classes.md

@@ -34,7 +34,7 @@ For example, if your Lambda function is being triggered by an API Gateway proxy
     def lambda_handler(event, context):
         event: APIGatewayProxyEvent = APIGatewayProxyEvent(event)
 
-        if 'helloworld' in event.path && event.http_method == 'GET':
+        if 'helloworld' in event.path and event.http_method == 'GET':
             do_something_with(event.body, user)
     ```
 
@@ -80,7 +80,7 @@ Typically used for API Gateway REST API or HTTP API using v1 proxy event.
         request_context = event.request_context
         identity = request_context.identity
 
-        if 'helloworld' in event.path && event.http_method == 'GET':
+        if 'helloworld' in event.path and event.http_method == 'GET':
             user = identity.user
             do_something_with(event.body, user)
     ```
@@ -97,7 +97,7 @@ Typically used for API Gateway REST API or HTTP API using v1 proxy event.
         request_context = event.request_context
         query_string_parameters = event.query_string_parameters
 
-        if 'helloworld' in event.raw_path && request_context.http.method == 'POST':
+        if 'helloworld' in event.raw_path and request_context.http.method == 'POST':
             do_something_with(event.body, query_string_parameters)
     ```
 
@@ -110,11 +110,12 @@ decompress and parse json data from the event.
 
     ```python
     from aws_lambda_powertools.utilities.data_classes import CloudWatchLogsEvent
+    from aws_lambda_powertools.utilities.data_classes.cloud_watch_logs_event import CloudWatchLogsDecodedData
 
     def lambda_handler(event, context):
         event: CloudWatchLogsEvent = CloudWatchLogsEvent(event)
 
-        decompressed_log = event.parse_logs_data
+        decompressed_log: CloudWatchLogsDecodedData = event.parse_logs_data
         log_events = decompressed_log.log_events
         for event in log_events:
             do_something_with(event.timestamp, event.message)
@@ -146,7 +147,7 @@ Verify Auth Challenge | `data_classes.cognito_user_pool_event.VerifyAuthChalleng
     def lambda_handler(event, context):
         event: PostConfirmationTriggerEvent = PostConfirmationTriggerEvent(event)
 
-        user_attributes = user_attributes = event.request.user_attributes
+        user_attributes = event.request.user_attributes
         do_something_with(user_attributes)
     ```
 
@@ -159,7 +160,10 @@ attributes values (`AttributeValue`), as well as enums for stream view type (`St
 === "lambda_app.py"
 
     ```python
-    from aws_lambda_powertools.utilities.data_classes.dynamo_db_stream_event import DynamoDBStreamEvent, DynamoDBRecordEventName
+    from aws_lambda_powertools.utilities.data_classes.dynamo_db_stream_event import (
+        DynamoDBStreamEvent,
+        DynamoDBRecordEventName
+    )
 
     def lambda_handler(event, context):
         event: DynamoDBStreamEvent = DynamoDBStreamEvent(event)
@@ -194,14 +198,16 @@ or plain text, depending on the original payload.
     ```python
     from aws_lambda_powertools.utilities.data_classes import KinesisStreamEvent
 
+
     def lambda_handler(event, context):
         event: KinesisStreamEvent = KinesisStreamEvent(event)
-
-        # if data was delivered as json
-        data = event.data_as_text()
+        kinesis_record = next(event.records).kinesis
 
         # if data was delivered as text
-        data = event.data_as_json()
+        data = kinesis_record.data_as_text()
+
+        # if data was delivered as json
+        data = kinesis_record.data_as_json()
 
         do_something_with(data)
     ```

Diff for: docs/utilities/idempotency.md

@@ -99,7 +99,7 @@ You can quickly start by initializing the `DynamoDBPersistenceLayer` class and u
         )
         ...
         return {
-            "payment_id": payment.id
+            "payment_id": payment.id,
             "message": "success",
             "statusCode": 200,
         }