runbooks 1.1.4__py3-none-any.whl → 1.1.6__py3-none-any.whl

runbooks/operate/s3_operations.py

@@ -737,16 +737,13 @@ class S3Operations(BaseOperation):
         return [result]
 
     def find_buckets_without_lifecycle(
-        self, 
-        context: OperationContext, 
-        region: Optional[str] = None, 
-        bucket_names: Optional[List[str]] = None
+        self, context: OperationContext, region: Optional[str] = None, bucket_names: Optional[List[str]] = None
     ) -> List[OperationResult]:
         """
         Find S3 buckets without lifecycle policies.
-        
+
         Enhanced from unSkript notebook: AWS_Add_Lifecycle_Policy_To_S3_Buckets.ipynb
-        Identifies buckets that do not have any configured lifecycle rules for 
+        Identifies buckets that do not have any configured lifecycle rules for
         managing object lifecycle, valuable for optimizing storage costs.
 
         Args:
@@ -757,15 +754,13 @@ class S3Operations(BaseOperation):
         Returns:
             List of operation results with buckets without lifecycle policies
         """
-        result = self.create_operation_result(
-            context, "find_buckets_without_lifecycle", "s3:bucket", "lifecycle-audit"
-        )
+        result = self.create_operation_result(context, "find_buckets_without_lifecycle", "s3:bucket", "lifecycle-audit")
 
         try:
             console.print(f"[bold blue]🔍 Scanning for S3 buckets without lifecycle policies...[/bold blue]")
-            
+
             buckets_without_policy = []
-            
+
             # Get list of regions to search
             search_regions = []
             if region:
@@ -786,7 +781,7 @@ class S3Operations(BaseOperation):
             for reg in search_regions:
                 try:
                     s3_client = self.get_client("s3", reg)
-                    
+
                     # Get buckets to check
                     if bucket_names:
                         # Check specific buckets
@@ -801,17 +796,19 @@ class S3Operations(BaseOperation):
                         try:
                             # Get bucket location to ensure it's in the current region
                             try:
-                                bucket_location = self.execute_aws_call(s3_client, "get_bucket_location", Bucket=bucket_name)
+                                bucket_location = self.execute_aws_call(
+                                    s3_client, "get_bucket_location", Bucket=bucket_name
+                                )
                                 bucket_region = bucket_location.get("LocationConstraint")
-                                
+
                                 # us-east-1 returns None for LocationConstraint
                                 if bucket_region is None:
                                     bucket_region = "us-east-1"
-                                
+
                                 # Skip if bucket is not in current region (when checking all regions)
                                 if not bucket_names and bucket_region != reg:
                                     continue
-                                    
+
                             except ClientError as e:
                                 if e.response["Error"]["Code"] in ["NoSuchBucket", "AccessDenied"]:
                                     continue
@@ -822,25 +819,29 @@ class S3Operations(BaseOperation):
                                 lifecycle_response = self.execute_aws_call(
                                     s3_client, "get_bucket_lifecycle_configuration", Bucket=bucket_name
                                 )
-                                
+
                                 # If we get here, bucket has lifecycle rules
                                 rules = lifecycle_response.get("Rules", [])
                                 if not rules:
                                     # Empty rules list means no active lifecycle
-                                    buckets_without_policy.append({
-                                        "bucket_name": bucket_name,
-                                        "region": bucket_region,
-                                        "issue": "Empty lifecycle configuration"
-                                    })
-                                    
+                                    buckets_without_policy.append(
+                                        {
+                                            "bucket_name": bucket_name,
+                                            "region": bucket_region,
+                                            "issue": "Empty lifecycle configuration",
+                                        }
+                                    )
+
                             except ClientError as e:
                                 if e.response["Error"]["Code"] == "NoSuchLifecycleConfiguration":
                                     # No lifecycle configuration found
-                                    buckets_without_policy.append({
-                                        "bucket_name": bucket_name,
-                                        "region": bucket_region,
-                                        "issue": "No lifecycle configuration"
-                                    })
+                                    buckets_without_policy.append(
+                                        {
+                                            "bucket_name": bucket_name,
+                                            "region": bucket_region,
+                                            "issue": "No lifecycle configuration",
+                                        }
+                                    )
                                 else:
                                     logger.warning(f"Could not check lifecycle for bucket {bucket_name}: {e}")
 
@@ -854,27 +855,26 @@ class S3Operations(BaseOperation):
 
             # Format results with Rich console output
             if buckets_without_policy:
-                console.print(f"[bold yellow]⚠️  Found {len(buckets_without_policy)} bucket(s) without lifecycle policies:[/bold yellow]")
-                
+                console.print(
+                    f"[bold yellow]⚠️  Found {len(buckets_without_policy)} bucket(s) without lifecycle policies:[/bold yellow]"
+                )
+
                 from rich.table import Table
+
                 table = Table(show_header=True, header_style="bold magenta")
                 table.add_column("Bucket Name", style="cyan")
                 table.add_column("Region", style="green")
                 table.add_column("Issue", style="yellow")
-                
+
                 for bucket_info in buckets_without_policy:
-                    table.add_row(
-                        bucket_info["bucket_name"],
-                        bucket_info["region"], 
-                        bucket_info["issue"]
-                    )
-                
+                    table.add_row(bucket_info["bucket_name"], bucket_info["region"], bucket_info["issue"])
+
                 console.print(table)
-                
+
                 result.response_data = {
                     "buckets_without_lifecycle": buckets_without_policy,
                     "total_count": len(buckets_without_policy),
-                    "regions_scanned": search_regions
+                    "regions_scanned": search_regions,
                 }
                 result.mark_completed(OperationStatus.SUCCESS)
             else:
@@ -883,7 +883,7 @@ class S3Operations(BaseOperation):
                     "buckets_without_lifecycle": [],
                     "total_count": 0,
                     "regions_scanned": search_regions,
-                    "message": "All buckets have lifecycle policies"
+                    "message": "All buckets have lifecycle policies",
                 }
                 result.mark_completed(OperationStatus.SUCCESS)
 
@@ -906,7 +906,7 @@ class S3Operations(BaseOperation):
     ) -> List[OperationResult]:
         """
         Add lifecycle policies to multiple S3 buckets in bulk.
-        
+
         Enhanced from unSkript notebook: AWS_Add_Lifecycle_Policy_To_S3_Buckets.ipynb
         Applies optimized lifecycle configuration for cost management.
 
@@ -923,32 +923,30 @@ class S3Operations(BaseOperation):
             List of operation results for each bucket processed
         """
         results = []
-        
+
         console.print(f"[bold blue]📋 Adding lifecycle policies to {len(bucket_list)} bucket(s)...[/bold blue]")
-        
+
         if context.dry_run:
             console.print("[yellow]🧪 DRY-RUN MODE: No actual changes will be made[/yellow]")
 
         for i, bucket_info in enumerate(bucket_list, 1):
             bucket_name = bucket_info.get("bucket_name")
             bucket_region = bucket_info.get("region")
-            
+
             if not bucket_name or not bucket_region:
                 logger.error(f"Invalid bucket info: {bucket_info}")
                 continue
-                
+
             console.print(f"[cyan]({i}/{len(bucket_list)}) Processing bucket: {bucket_name}[/cyan]")
 
-            result = self.create_operation_result(
-                context, "add_lifecycle_policy", "s3:bucket", bucket_name
-            )
+            result = self.create_operation_result(context, "add_lifecycle_policy", "s3:bucket", bucket_name)
 
             try:
                 s3_client = self.get_client("s3", bucket_region)
 
                 # Build lifecycle configuration
                 lifecycle_rules = []
-                
+
                 # Main lifecycle rule
                 rule = {
                     "ID": f"lifecycle-rule-{int(datetime.now().timestamp())}",
@@ -964,17 +962,11 @@ class S3Operations(BaseOperation):
                 # Add storage class transitions
                 transitions = []
                 if transition_ia_days and transition_ia_days < expiration_days:
-                    transitions.append({
-                        "Days": transition_ia_days,
-                        "StorageClass": "STANDARD_IA"
-                    })
-                
+                    transitions.append({"Days": transition_ia_days, "StorageClass": "STANDARD_IA"})
+
                 if transition_glacier_days and transition_glacier_days < expiration_days:
-                    transitions.append({
-                        "Days": transition_glacier_days,
-                        "StorageClass": "GLACIER"
-                    })
-                
+                    transitions.append({"Days": transition_glacier_days, "StorageClass": "GLACIER"})
+
                 if transitions:
                     rule["Transitions"] = transitions
 
@@ -988,7 +980,7 @@ class S3Operations(BaseOperation):
                         "bucket_name": bucket_name,
                         "region": bucket_region,
                         "lifecycle_config": lifecycle_config,
-                        "dry_run": True
+                        "dry_run": True,
                     }
                     result.mark_completed(OperationStatus.DRY_RUN)
                 else:
@@ -997,16 +989,16 @@ class S3Operations(BaseOperation):
                         s3_client,
                         "put_bucket_lifecycle_configuration",
                         Bucket=bucket_name,
-                        LifecycleConfiguration=lifecycle_config
+                        LifecycleConfiguration=lifecycle_config,
                     )
 
                     console.print(f"[green]  ✅ Successfully applied lifecycle policy to {bucket_name}[/green]")
-                    
+
                     result.response_data = {
                         "bucket_name": bucket_name,
                         "region": bucket_region,
                         "lifecycle_config": lifecycle_config,
-                        "aws_response": response
+                        "aws_response": response,
                     }
                     result.mark_completed(OperationStatus.SUCCESS)
 
@@ -1026,7 +1018,7 @@ class S3Operations(BaseOperation):
         # Summary report
         successful = len([r for r in results if r.success])
         failed = len(results) - successful
-        
+
         if context.dry_run:
             console.print(f"[yellow]🧪 DRY-RUN SUMMARY: Would process {len(results)} bucket(s)[/yellow]")
         else:
@@ -1037,9 +1029,7 @@ class S3Operations(BaseOperation):
 
         return results
 
-    def get_bucket_lifecycle(
-        self, context: OperationContext, bucket_name: str
-    ) -> List[OperationResult]:
+    def get_bucket_lifecycle(self, context: OperationContext, bucket_name: str) -> List[OperationResult]:
         """
         Get current lifecycle configuration for an S3 bucket.
 
@@ -1051,56 +1041,49 @@ class S3Operations(BaseOperation):
             List of operation results with current lifecycle configuration
         """
         s3_client = self.get_client("s3")
-        
-        result = self.create_operation_result(
-            context, "get_bucket_lifecycle", "s3:bucket", bucket_name
-        )
+
+        result = self.create_operation_result(context, "get_bucket_lifecycle", "s3:bucket", bucket_name)
 
         try:
             console.print(f"[blue]🔍 Checking lifecycle configuration for bucket: {bucket_name}[/blue]")
-            
+
             try:
-                response = self.execute_aws_call(
-                    s3_client, "get_bucket_lifecycle_configuration", Bucket=bucket_name
-                )
-                
+                response = self.execute_aws_call(s3_client, "get_bucket_lifecycle_configuration", Bucket=bucket_name)
+
                 rules = response.get("Rules", [])
                 console.print(f"[green]✅ Found {len(rules)} lifecycle rule(s) for bucket {bucket_name}[/green]")
-                
+
                 # Display rules in a formatted table
                 if rules:
                     from rich.table import Table
+
                     table = Table(show_header=True, header_style="bold magenta")
                     table.add_column("Rule ID", style="cyan")
                     table.add_column("Status", style="green")
                     table.add_column("Prefix", style="yellow")
                     table.add_column("Expiration", style="red")
-                    
+
                     for rule in rules:
                         rule_id = rule.get("ID", "N/A")
                         status = rule.get("Status", "N/A")
-                        
+
                         # Handle different filter formats
                         filter_info = rule.get("Filter", {})
                         if isinstance(filter_info, dict):
                             prefix = filter_info.get("Prefix", "")
                         else:
                             prefix = ""
-                            
+
                         expiration = rule.get("Expiration", {})
                         exp_days = expiration.get("Days", "N/A")
-                        
+
                         table.add_row(rule_id, status, prefix or "All objects", str(exp_days))
-                    
+
                     console.print(table)
-                
-                result.response_data = {
-                    "bucket_name": bucket_name,
-                    "lifecycle_rules": rules,
-                    "rules_count": len(rules)
-                }
+
+                result.response_data = {"bucket_name": bucket_name, "lifecycle_rules": rules, "rules_count": len(rules)}
                 result.mark_completed(OperationStatus.SUCCESS)
-                
+
             except ClientError as e:
                 if e.response["Error"]["Code"] == "NoSuchLifecycleConfiguration":
                     console.print(f"[yellow]⚠️  No lifecycle configuration found for bucket {bucket_name}[/yellow]")
@@ -1108,7 +1091,7 @@ class S3Operations(BaseOperation):
                         "bucket_name": bucket_name,
                         "lifecycle_rules": [],
                         "rules_count": 0,
-                        "message": "No lifecycle configuration"
+                        "message": "No lifecycle configuration",
                     }
                     result.mark_completed(OperationStatus.SUCCESS)
                 else:
@@ -1126,9 +1109,9 @@ class S3Operations(BaseOperation):
     ) -> List[OperationResult]:
         """
         Analyze lifecycle compliance across S3 buckets and provide cost optimization recommendations.
-        
+
         Args:
-            context: Operation context  
+            context: Operation context
             region: AWS region to analyze (if None, analyzes all regions)
 
         Returns:
@@ -1139,41 +1122,47 @@ class S3Operations(BaseOperation):
         )
 
         try:
-            console.print("[bold blue]📊 Analyzing S3 lifecycle compliance and cost optimization opportunities...[/bold blue]")
-            
+            console.print(
+                "[bold blue]📊 Analyzing S3 lifecycle compliance and cost optimization opportunities...[/bold blue]"
+            )
+
             # Find buckets without lifecycle policies
             find_results = self.find_buckets_without_lifecycle(context, region=region)
-            
+
             if not find_results or not find_results[0].success:
                 result.mark_completed(OperationStatus.FAILED, "Failed to analyze buckets")
                 return [result]
-                
+
             buckets_data = find_results[0].response_data
             non_compliant_buckets = buckets_data.get("buckets_without_lifecycle", [])
             total_buckets_scanned = buckets_data.get("total_count", 0)
-            
+
             # Calculate compliance metrics
             s3_client = self.get_client("s3")
-            
+
             # Get total bucket count for compliance percentage
             list_response = self.execute_aws_call(s3_client, "list_buckets")
             total_buckets = len(list_response.get("Buckets", []))
-            
-            compliance_percentage = ((total_buckets - len(non_compliant_buckets)) / total_buckets * 100) if total_buckets > 0 else 100
-            
+
+            compliance_percentage = (
+                ((total_buckets - len(non_compliant_buckets)) / total_buckets * 100) if total_buckets > 0 else 100
+            )
+
             # Generate recommendations
             recommendations = []
             potential_savings = 0
-            
+
             if non_compliant_buckets:
-                recommendations.extend([
-                    "🎯 Implement lifecycle policies to automatically transition objects to cheaper storage classes",
-                    "💰 Configure automatic deletion of old object versions to reduce storage costs",
-                    "📈 Set up transitions: Standard → IA (30 days) → Glacier (90 days) → Deep Archive (365 days)",
-                    "🔧 Use prefixes to apply different policies to different object types",
-                    "📊 Monitor lifecycle rule effectiveness with CloudWatch metrics"
-                ])
-                
+                recommendations.extend(
+                    [
+                        "🎯 Implement lifecycle policies to automatically transition objects to cheaper storage classes",
+                        "💰 Configure automatic deletion of old object versions to reduce storage costs",
+                        "📈 Set up transitions: Standard → IA (30 days) → Glacier (90 days) → Deep Archive (365 days)",
+                        "🔧 Use prefixes to apply different policies to different object types",
+                        "📊 Monitor lifecycle rule effectiveness with CloudWatch metrics",
+                    ]
+                )
+
                 # Estimate potential savings (rough calculation)
                 estimated_savings_per_bucket = 25  # Estimated 25% savings per bucket
                 potential_savings = len(non_compliant_buckets) * estimated_savings_per_bucket
@@ -1181,26 +1170,26 @@ class S3Operations(BaseOperation):
             # Create summary report
             from rich.panel import Panel
             from rich.table import Table
-            
+
             # Compliance summary table
             summary_table = Table(show_header=True, header_style="bold magenta")
             summary_table.add_column("Metric", style="cyan")
             summary_table.add_column("Value", style="green")
-            
+
             summary_table.add_row("Total Buckets", str(total_buckets))
             summary_table.add_row("Compliant Buckets", str(total_buckets - len(non_compliant_buckets)))
             summary_table.add_row("Non-Compliant Buckets", str(len(non_compliant_buckets)))
             summary_table.add_row("Compliance Percentage", f"{compliance_percentage:.1f}%")
             summary_table.add_row("Potential Cost Savings", f"~{potential_savings}%")
-            
+
             console.print(Panel(summary_table, title="S3 Lifecycle Compliance Report", border_style="blue"))
-            
+
             # Display recommendations if any
             if recommendations:
                 console.print("\n[bold yellow]💡 Cost Optimization Recommendations:[/bold yellow]")
                 for i, rec in enumerate(recommendations, 1):
                     console.print(f"  {i}. {rec}")
-            
+
             # Compliance status color coding
             if compliance_percentage >= 90:
                 compliance_status = "[bold green]EXCELLENT[/bold green]"
@@ -1210,9 +1199,9 @@ class S3Operations(BaseOperation):
                 compliance_status = "[bold orange]NEEDS IMPROVEMENT[/bold orange]"
             else:
                 compliance_status = "[bold red]POOR[/bold red]"
-                
+
             console.print(f"\n[bold blue]Overall Compliance Status: {compliance_status}[/bold blue]")
-            
+
             result.response_data = {
                 "compliance_percentage": compliance_percentage,
                 "total_buckets": total_buckets,
@@ -1221,7 +1210,7 @@ class S3Operations(BaseOperation):
                 "non_compliant_details": non_compliant_buckets,
                 "recommendations": recommendations,
                 "potential_savings_percentage": potential_savings,
-                "compliance_status": compliance_status.replace("[bold ", "").replace("[/bold ", "").replace("]", "")
+                "compliance_status": compliance_status.replace("[bold ", "").replace("[/bold ", "").replace("]", ""),
             }
             result.mark_completed(OperationStatus.SUCCESS)