AWS code-library documentation change
Summary
Refactored S3 Batch Operations example code with improved error handling, added job management methods (create/check/update/cancel jobs), enhanced resource cleanup, and expanded documentation for AWS service client usage.
Security assessment
The changes focus on code structure improvements and added functionality for S3 Batch Operations management. While the example includes IAM role usage and error handling patterns, there's no evidence of addressing specific security vulnerabilities or documenting new security features. The S3PutObjectTagging operation shown is part of normal data management rather than security hardening.
Diff
diff --git a/code-library/latest/ug/s3-control_example_s3-control_Basics_section.md b/code-library/latest/ug/s3-control_example_s3-control_Basics_section.md index 6aa191cba..7388017c0 100644 --- a//code-library/latest/ug/s3-control_example_s3-control_Basics_section.md +++ b//code-library/latest/ug/s3-control_example_s3-control_Basics_section.md @@ -951,2 +951,2 @@ Learn S3 Batch Basics Scenario. - class S3BatchScenario: - """Manages the S3 Batch Operations scenario.""" + class S3BatchWrapper: + """Wrapper class for managing S3 Batch Operations.""" @@ -954,2 +954,50 @@ Learn S3 Batch Basics Scenario. - DASHES = "-" * 80 - STACK_NAME = "MyS3Stack" + def __init__(self, s3_client: Any, s3control_client: Any, sts_client: Any) -> None: + """ + Initializes the S3BatchWrapper with AWS service clients. + + :param s3_client: A Boto3 Amazon S3 client. This client provides low-level + access to AWS S3 services. + :param s3control_client: A Boto3 Amazon S3 Control client. This client provides + low-level access to AWS S3 Control services. + :param sts_client: A Boto3 AWS STS client. This client provides low-level + access to AWS STS services. + """ + self.s3_client = s3_client + self.s3control_client = s3control_client + self.sts_client = sts_client + # Get region from the client for bucket creation logic + self.region_name = self.s3_client.meta.region_name + + def get_account_id(self) -> str: + """ + Get AWS account ID. + + Returns: + str: AWS account ID + """ + return self.sts_client.get_caller_identity()["Account"] + + def create_bucket(self, bucket_name: str) -> None: + """ + Create an S3 bucket. + + Args: + bucket_name (str): Name of the bucket to create + + Raises: + ClientError: If bucket creation fails + """ + try: + if self.region_name and self.region_name != 'us-east-1': + self.s3_client.create_bucket( + Bucket=bucket_name, + CreateBucketConfiguration={ + 'LocationConstraint': self.region_name + } + ) + else: + self.s3_client.create_bucket(Bucket=bucket_name) + print(f"Created bucket: {bucket_name}") + except ClientError as e: + print(f"Error creating bucket: {e}") + raise @@ -957 +1005 @@ Learn S3 Batch Basics Scenario. - def __init__(self, s3_batch_wrapper: S3BatchWrapper, cfn_helper: CloudFormationHelper) -> None: + def upload_files_to_bucket(self, bucket_name: str, file_names: List[str]) -> str: @@ -959 +1007 @@ Learn S3 Batch Basics Scenario. - Initialize the S3 Batch scenario. + Upload files to S3 bucket including manifest file. @@ -962,2 +1010,8 @@ Learn S3 Batch Basics Scenario. - s3_batch_wrapper: S3BatchWrapper instance - cfn_helper: CloudFormationHelper instance + bucket_name (str): Target bucket name + file_names (list): List of file names to upload + + Returns: + str: ETag of the manifest file + + Raises: + ClientError: If file upload fails @@ -965,2 +1019,10 @@ Learn S3 Batch Basics Scenario. - self.s3_batch_wrapper = s3_batch_wrapper - self.cfn_helper = cfn_helper + try: + for file_name in file_names: + if file_name != "job-manifest.csv": + content = f"Content for {file_name}" + self.s3_client.put_object( + Bucket=bucket_name, + Key=file_name, + Body=content.encode('utf-8') + ) + print(f"Uploaded {file_name} to {bucket_name}") @@ -968,4 +1030,4 @@ Learn S3 Batch Basics Scenario. - def wait_for_input(self) -> None: - """Wait for user input to continue.""" - q.ask("\nPress Enter to continue...") - print() + manifest_content = "" + for file_name in file_names: + if file_name != "job-manifest.csv": + manifest_content += f"{bucket_name},{file_name}\n" @@ -973 +1035,15 @@ Learn S3 Batch Basics Scenario. - def setup_resources(self, bucket_name: str, file_names: list) -> Tuple[str, str]: + manifest_response = self.s3_client.put_object( + Bucket=bucket_name, + Key="job-manifest.csv", + Body=manifest_content.encode('utf-8') + ) + print(f"Uploaded manifest file to {bucket_name}") + print(f"Manifest content:\n{manifest_content}") + return manifest_response['ETag'].strip('"') + + except ClientError as e: + print(f"Error uploading files: {e}") + raise + + def create_s3_batch_job(self, account_id: str, role_arn: str, manifest_location: str, + report_bucket_name: str) -> str: @@ -975 +1051 @@ Learn S3 Batch Basics Scenario. - Set up initial resources for the scenario. + Create an S3 batch operation job. @@ -978,2 +1054,4 @@ Learn S3 Batch Basics Scenario. - bucket_name (str): Name of the bucket to create - file_names (list): List of files to upload + account_id (str): AWS account ID + role_arn (str): IAM role ARN for batch operations + manifest_location (str): Location of the manifest file + report_bucket_name (str): Bucket for job reports @@ -982 +1060,4 @@ Learn S3 Batch Basics Scenario. - tuple: Manifest location and report bucket ARN + str: Job ID + + Raises: + ClientError: If job creation fails @@ -984,17 +1065,18 @@ Learn S3 Batch Basics Scenario. - print("\nSetting up required resources...") - self.s3_batch_wrapper.create_bucket(bucket_name) - report_bucket_arn = f"arn:aws:s3:::{bucket_name}" - manifest_location = f"arn:aws:s3:::{bucket_name}/job-manifest.csv" - self.s3_batch_wrapper.upload_files_to_bucket(bucket_name, file_names) - return manifest_location, report_bucket_arn - - def run_scenario(self) -> None: - """Run the S3 Batch Operations scenario.""" - account_id = self.s3_batch_wrapper.get_account_id() - bucket_name = f"demo-s3-batch-{str(uuid.uuid4())}" - file_names = [ - "job-manifest.csv", - "object-key-1.txt", - "object-key-2.txt", - "object-key-3.txt", - "object-key-4.txt" + try: + bucket_name = manifest_location.split(':::')[1].split('/')[0] + manifest_key = 'job-manifest.csv' + manifest_obj = self.s3_client.head_object( + Bucket=bucket_name, + Key=manifest_key + ) + etag = manifest_obj['ETag'].strip('"') + + response = self.s3control_client.create_job( + AccountId=account_id, + Operation={ + 'S3PutObjectTagging': { + 'TagSet': [ + { + 'Key': 'BatchTag', + 'Value': 'BatchValue' + }, @@ -1001,0 +1084,32 @@ Learn S3 Batch Basics Scenario. + } + }, + Report={ + 'Bucket': report_bucket_name, + 'Format': 'Report_CSV_20180820', + 'Enabled': True, + 'Prefix': 'batch-op-reports', + 'ReportScope': 'AllTasks' + }, + Manifest={ + 'Spec': { + 'Format': 'S3BatchOperations_CSV_20180820', + 'Fields': ['Bucket', 'Key'] + }, + 'Location': { + 'ObjectArn': manifest_location, + 'ETag': etag + } + }, + Priority=10, + RoleArn=role_arn, + Description='Batch job for tagging objects', + ConfirmationRequired=True + ) + job_id = response['JobId'] + print(f"The Job id is {job_id}") + return job_id + except ClientError as e: + print(f"Error creating batch job: {e}")