fix flake8 errors in config module

Author: cyphronix

aws_sra_examples/solutions/genai/bedrock_org/lambda/src/app.py

@@ -255,7 +255,7 @@ def load_sra_cloudwatch_dashboard() -> dict:
 s3 = sra_s3.sra_s3()
 lambdas = sra_lambda.sra_lambda()
 sns = sra_sns.sra_sns()
-config = sra_config.sra_config()
+config = sra_config.SRAConfig()
 cloudwatch = sra_cloudwatch.SRACloudWatch()
 kms = sra_kms.sra_kms()
 

aws_sra_examples/solutions/genai/bedrock_org/lambda/src/sra_config.py

@@ -12,30 +12,25 @@
 
 import logging
 import os
-from time import sleep
 
-from typing import TYPE_CHECKING, Literal, Optional
-from typing import cast
+from typing import TYPE_CHECKING, Literal
 
 import boto3
 from botocore.config import Config
 from botocore.exceptions import ClientError
 
-import urllib.parse
 import json
 
-import cfnresponse
 
 if TYPE_CHECKING:
-    from mypy_boto3_cloudformation import CloudFormationClient
     from mypy_boto3_organizations import OrganizationsClient
     from mypy_boto3_config import ConfigServiceClient
-    from mypy_boto3_config.type_defs import DescribeConfigRulesResponseTypeDef, ConfigRuleTypeDef, ScopeTypeDef
-    from mypy_boto3_iam.client import IAMClient
-    from mypy_boto3_iam.type_defs import CreatePolicyResponseTypeDef, CreateRoleResponseTypeDef, EmptyResponseMetadataTypeDef
+    from mypy_boto3_config.type_defs import DescribeConfigRulesResponseTypeDef
 
 
-class sra_config:
+class SRAConfig:
+    """Class to setup SRA Config resources in the organization."""
+
     # Setup Default Logger
     LOGGER = logging.getLogger(__name__)
     log_level: str = os.environ.get("LOG_LEVEL", "INFO")
@@ -53,48 +48,56 @@ class sra_config:
         raise ValueError("Unexpected error executing Lambda function. Review CloudWatch logs for details.") from None
 
     def get_organization_config_rules(self) -> dict:
-        """Get Organization Config Rules."""
+        """Get Organization Config Rules.
+
+        Returns:
+            dict: Organization Config Rules
+        """
         # Get the Organization ID
         org_id: str = self.ORG_CLIENT.describe_organization()["Organization"]["Id"]
 
         # Get the Organization Config Rules
-        response = self.ORG_CLIENT.describe_organization_config_rules( # type: ignore
+        response = self.ORG_CLIENT.describe_organization_config_rules(  # type: ignore
             OrganizationConfigRuleNames=["sra_config_rule"],
             OrganizationId=org_id,
         )
 
         # Log the response
-        sra_config.LOGGER.info(response)
+        self.LOGGER.info(response)
 
         # Return the response
         return response
 
     def put_organization_config_rule(self) -> dict:
-        """Put Organization Config Rule."""
+        """Put Organization Config Rule.
+
+        Returns:
+            dict: Organization Config Rule
+        """
         # Get the Organization ID
         org_id: str = self.ORG_CLIENT.describe_organization()["Organization"]["Id"]
 
         # Put the Organization Config Rule
-        response = self.ORG_CLIENT.put_organization_config_rule( # type: ignore
+        response = self.ORG_CLIENT.put_organization_config_rule(  # type: ignore
             OrganizationConfigRuleName="sra_config_rule",
             OrganizationId=org_id,
             ConfigRuleName="sra_config_rule",
         )
 
         # Log the response
-        sra_config.LOGGER.info(response)
+        self.LOGGER.info(response)
 
         # Return the response
         return response
 
     def find_config_rule(self, rule_name: str) -> tuple[bool, dict | DescribeConfigRulesResponseTypeDef]:
-        """Get config rule
+        """Get config rule.
 
         Args:
             rule_name (str): Config rule name
 
         Raises:
-            ValueError: If the config rule is not found
+            ValueError: Unexpected error executing Lambda function. Review CloudWatch logs for details.
 
         Returns:
             tuple[bool, dict | DescribeConfigRulesResponseTypeDef]: True if the config rule is found, False if not, and the response
@@ -110,19 +113,27 @@ def find_config_rule(self, rule_name: str) -> tuple[bool, dict | DescribeConfigR
             if e.response["Error"]["Code"] == "NoSuchConfigRuleException":
                 self.LOGGER.info(f"No such config rule: {rule_name}")
                 return False, {}
-            else:
-                self.LOGGER.info(f"Unexpected error: {e}")
-                raise e
-        # Log the response
+            self.LOGGER.info(f"Unexpected error: {e}")
+            raise ValueError(f"Unexpected error executing Lambda function. Review CloudWatch logs for details. {e}") from None
         self.LOGGER.info(f"Config rule {rule_name} exists: {response}")
         return True, response
 
-
-    def create_config_rule(self, rule_name: str, lambda_arn: str, 
-                           max_frequency: Literal["One_Hour", "Three_Hours", "Six_Hours", "Twelve_Hours", "TwentyFour_Hours"], 
-                           owner: Literal["CUSTOM_LAMBDA", "AWS"], description: str, input_params: dict, 
+    def create_config_rule(self, rule_name: str, lambda_arn: str,  # noqa: CFQ002
+                           max_frequency: Literal["One_Hour", "Three_Hours", "Six_Hours", "Twelve_Hours", "TwentyFour_Hours"],
+                           owner: Literal["CUSTOM_LAMBDA", "AWS"], description: str, input_params: dict,
                            eval_mode: Literal["DETECTIVE", "PROACTIVE"], solution_name: str) -> None:
-        """Create Config Rule."""
+        """Create Config Rule.
+
+        Args:
+            rule_name (str): Config rule name
+            lambda_arn (str): Lambda ARN
+            max_frequency (Literal["One_Hour", "Three_Hours", "Six_Hours", "Twelve_Hours", "TwentyFour_Hours"]): Config rule max frequency
+            owner (Literal["CUSTOM_LAMBDA", "AWS"]): Config rule owner
+            description (str): Config rule description
+            input_params (dict): Config rule input parameters
+            eval_mode (Literal["DETECTIVE", "PROACTIVE"]): Config rule evaluation mode
+            solution_name (str): SRA solution name
+        """
         self.CONFIG_CLIENT.put_config_rule(
             ConfigRule={
                 "ConfigRuleName": rule_name,
@@ -153,7 +164,11 @@ def create_config_rule(self, rule_name: str, lambda_arn: str,
         self.LOGGER.info(f"{rule_name} config rule created...")
 
     def delete_config_rule(self, rule_name: str) -> None:
-        """Delete Config Rule."""
+        """Delete Config Rule.
+
+        Args:
+            rule_name (str): Config rule name
+        """
         # Delete the Config Rule
         try:
             self.CONFIG_CLIENT.delete_config_rule(
@@ -166,4 +181,4 @@ def delete_config_rule(self, rule_name: str) -> None:
             if e.response["Error"]["Code"] == "NoSuchConfigRuleException":
                 self.LOGGER.info(f"No such config rule: {rule_name}")
             else:
-                self.LOGGER.info(f"Unexpected error: {e}")
+                self.LOGGER.info(f"Unexpected error: {e}")