docs(data-classes): Add docs for CodePipelineJobEvent

Author: Michael Brewer

aws_lambda_powertools/utilities/data_classes/__init__.py

@@ -6,6 +6,7 @@
 from .api_gateway_proxy_event import APIGatewayProxyEvent, APIGatewayProxyEventV2
 from .appsync_resolver_event import AppSyncResolverEvent
 from .cloud_watch_logs_event import CloudWatchLogsEvent
+from .code_pipeline_job_event import CodePipelineJobEvent
 from .connect_contact_flow_event import ConnectContactFlowEvent
 from .dynamo_db_stream_event import DynamoDBStreamEvent
 from .event_bridge_event import EventBridgeEvent
@@ -21,6 +22,7 @@
     "AppSyncResolverEvent",
     "ALBEvent",
     "CloudWatchLogsEvent",
+    "CodePipelineJobEvent",
     "ConnectContactFlowEvent",
     "DynamoDBStreamEvent",
     "EventBridgeEvent",

docs/utilities/data_classes.md

@@ -52,6 +52,7 @@ Event Source | Data_class
 [API Gateway Proxy event v2](#api-gateway-proxy-v2) | `APIGatewayProxyEventV2`
 [AppSync Resolver](#appsync-resolver) | `AppSyncResolverEvent`
 [CloudWatch Logs](#cloudwatch-logs) | `CloudWatchLogsEvent`
+[CodePipeline Job Event](#codepipeline-job) | `CodePipelineJobEvent`
 [Cognito User Pool](#cognito-user-pool) | Multiple available under `cognito_user_pool_event`
 [Connect Contact Flow](#connect-contact-flow) | `ConnectContactFlowEvent`
 [DynamoDB streams](#dynamodb-streams) | `DynamoDBStreamEvent`, `DynamoDBRecordEventName`
@@ -222,6 +223,58 @@ decompress and parse json data from the event.
             do_something_with(event.timestamp, event.message)
     ```
 
+### CodePipeline Job
+
+Data classes and utility functions to help create continuous delivery pipelines tasks with AWS Lambda
+
+=== "app.py"
+
+    ```python
+    from aws_lambda_powertools import Logger
+    from aws_lambda_powertools.utilities.data_classes import CodePipelineJobEvent
+
+    logger = Logger()
+
+
+    def lambda_handler(event, context):
+        """The Lambda function handler
+
+        If a continuing job then checks the CloudFormation stack status
+        and updates the job accordingly.
+
+        If a new job then kick of an update or creation of the target
+        CloudFormation stack.
+        """
+        event: CodePipelineJobEvent = CodePipelineJobEvent(event)
+
+        # Extract the Job ID
+        job_id = event.get_id
+
+        # Extract the params
+        params: dict = event.decoded_user_parameters
+        stack = params["stack"]
+        artifact_name = params["artifact"]
+        template_file = params["file"]
+
+        try:
+            if event.data.continuation_token:
+                # If we're continuing then the create/update has already been triggered
+                # we just need to check if it has finished.
+                check_stack_update_status(job_id, stack)
+            else:
+                template = event.get_artifact(artifact_name, template_file)
+                # Kick off a stack update or create
+                start_update_or_create(job_id, stack, template)
+        except Exception as e:
+            # If any other exceptions which we didn't expect are raised
+            # then fail the job and log the exception message.
+            logger.exception("Function failed due to exception.")
+            put_job_failure(job_id, "Function exception: " + str(e))
+
+        logger.debug("Function complete.")
+        return "Complete."
+    ```
+
 ### Cognito User Pool
 
 Cognito User Pools have several [different Lambda trigger sources](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html#cognito-user-identity-pools-working-with-aws-lambda-trigger-sources), all of which map to a different data class, which

tests/functional/test_data_classes.py

@@ -13,6 +13,7 @@
     APIGatewayProxyEventV2,
     AppSyncResolverEvent,
     CloudWatchLogsEvent,
+    CodePipelineJobEvent,
     EventBridgeEvent,
     KinesisStreamEvent,
     S3Event,
@@ -34,7 +35,7 @@
     AppSyncResolverEventInfo,
     get_identity_object,
 )
-from aws_lambda_powertools.utilities.data_classes.code_pipeline_job_event import CodePipelineData, CodePipelineJobEvent
+from aws_lambda_powertools.utilities.data_classes.code_pipeline_job_event import CodePipelineData
 from aws_lambda_powertools.utilities.data_classes.cognito_user_pool_event import (
     CreateAuthChallengeTriggerEvent,
     CustomMessageTriggerEvent,