Python: Add S3 Batch scenario with CloudFormation integration

.doc_gen/metadata/s3-control_metadata.yaml

@@ -13,6 +13,15 @@ s3-control_Hello:
             - description:
               snippet_tags:
                 - s3control.java2.list_jobs.main
+    Python:
+      versions:
+        - sdk_version: 3
+          github: python/example_code/s3/scenarios/batch
+          sdkguide:
+          excerpts:
+            - description:
+              snippet_tags:
+                - python.example_code.s3control.list_jobs
   services:
     s3-control: {ListJobs}
 
@@ -29,15 +38,24 @@ s3-control_CreateJob:
                 - s3control.java2.create_job.async.main
             - description: Create a compliance retention job.
               snippet_tags:
-                - s3control.java2.create_job.compliance.main   
+                - s3control.java2.create_job.compliance.main
             - description: Create a legal hold off job.
               snippet_tags:
-                - s3control.java2.create_job.compliance.main  
+                - s3control.java2.create_job.compliance.main
             - description: Create a new governance retention job.
               snippet_tags:
-                - s3.java2.create_governance_retemtion.main       
+                - s3.java2.create_governance_retemtion.main
+    Python:
+      versions:
+        - sdk_version: 3
+          github: python/example_code/s3/scenarios/batch
+          sdkguide:
+          excerpts:
+            - description:
+              snippet_tags:
+                - python.example_code.s3control.create_job
   services:
-    s3-control: {CreateJob}    
+    s3-control: {CreateJob}
 s3-control_PutJobTagging:
   languages:
     Java:
@@ -49,8 +67,17 @@ s3-control_PutJobTagging:
             - description:
               snippet_tags:
                 - s3control.java2.job.put.tags.main
+    Python:
+      versions:
+        - sdk_version: 3
+          github: python/example_code/s3/scenarios/batch
+          sdkguide:
+          excerpts:
+            - description:
+              snippet_tags:
+                - python.example_code.s3control.put_job_tagging
   services:
-    s3-control: {PutJobTagging}  
+    s3-control: {PutJobTagging}
 s3-control_DescribeJob:
   languages:
     Java:
@@ -62,8 +89,17 @@ s3-control_DescribeJob:
             - description:
               snippet_tags:
                 - s3control.java2.describe_job.main
+    Python:
+      versions:
+        - sdk_version: 3
+          github: python/example_code/s3/scenarios/batch
+          sdkguide:
+          excerpts:
+            - description:
+              snippet_tags:
+                - python.example_code.s3control.describe_job
   services:
-    s3-control: {DescribeJob}  
+    s3-control: {DescribeJob}
 s3-control_DeleteJobTagging:
   languages:
     Java:
@@ -75,8 +111,17 @@ s3-control_DeleteJobTagging:
             - description:
               snippet_tags:
                 - s3control.java2.del_job_tagging.main
+    Python:
+      versions:
+        - sdk_version: 3
+          github: python/example_code/s3/scenarios/batch
+          sdkguide:
+          excerpts:
+            - description:
+              snippet_tags:
+                - python.example_code.s3control.delete_job_tagging
   services:
-    s3-control: {DeleteJobTagging}  
+    s3-control: {DeleteJobTagging}
 s3-control_GetJobTagging:
   languages:
     Java:
@@ -88,8 +133,17 @@ s3-control_GetJobTagging:
             - description:
               snippet_tags:
                 - s3control.java2.get_job_tagging.main
+    Python:
+      versions:
+        - sdk_version: 3
+          github: python/example_code/s3/scenarios/batch
+          sdkguide:
+          excerpts:
+            - description:
+              snippet_tags:
+                - python.example_code.s3control.get_job_tagging
   services:
-    s3-control: {GetJobTagging}   
+    s3-control: {GetJobTagging}
 s3-control_UpdateJobStatus:
   languages:
     Java:
@@ -101,8 +155,17 @@ s3-control_UpdateJobStatus:
             - description:
               snippet_tags:
                 - s3control.java2.cancel_job.main
+    Python:
+      versions:
+        - sdk_version: 3
+          github: python/example_code/s3/scenarios/batch
+          sdkguide:
+          excerpts:
+            - description:
+              snippet_tags:
+                - python.example_code.s3control.update_job_status
   services:
-    s3-control: {UpdateJobStatus}   
+    s3-control: {UpdateJobStatus}
 s3-control_UpdateJobPriority:
   languages:
     Java:
@@ -114,8 +177,17 @@ s3-control_UpdateJobPriority:
             - description:
               snippet_tags:
                 - s3control.java2.update_job.main
+    Python:
+      versions:
+        - sdk_version: 3
+          github: python/example_code/s3/scenarios/batch
+          sdkguide:
+          excerpts:
+            - description:
+              snippet_tags:
+                - python.example_code.s3control.update_job_priority
   services:
-    s3-control: {UpdateJobPriority}   
+    s3-control: {UpdateJobPriority}
 s3-control_Basics:
   synopsis: learn core operations for &S3Control;.
   category: Basics
@@ -132,5 +204,24 @@ s3-control_Basics:
             - description: An action class that wraps operations.
               snippet_tags:
                 - s3control.java2.job.actions.main
+    Python:
+      versions:
+        - sdk_version: 3
+          github: python/example_code/s3/scenarios/batch
+          sdkguide:
+          excerpts:
+            - description: Learn S3 Batch Basics Scenario.
+              snippet_tags:
+                - python.example_code.s3control.helper.S3BatchScenario
   services:
-    s3-control: {CreateJob, DeleteJobTagging, DescribeJob, GetJobTagging, ListJobs, PutJobTagging, UpdateJobPriority, UpdateJobStatus}
+    s3-control:
+      {
+        CreateJob,
+        DeleteJobTagging,
+        DescribeJob,
+        GetJobTagging,
+        ListJobs,
+        PutJobTagging,
+        UpdateJobPriority,
+        UpdateJobStatus,
+      }

python/example_code/s3/scenarios/batch/README.md

@@ -0,0 +1,56 @@
+# Amazon S3 Batch for the SDK for Python (boto3)
+
+## Overview
+
+This example demonstrates how to use the AWS SDK for Python (boto3) to work with Amazon Simple Storage Service (Amazon S3) Batch Scenario. The scenario covers various operations such as creating an AWS Batch compute environment, creating a job queue, creating a job defination, and submitting a job, and so on.
+
+Here are the top six service operations this scenario covers.
+
+1. **Create an AWS Batch computer environment**: Creates an AWS Batch computer environment.
+
+2. **Sets up a job queue**: Creates a job queue that will manage the submission of jobs.
+
+3. **Creates a job definition**: Creates a job definition that specifies how the jobs should be executed.
+
+4. **Registers a Job Definition**: Registers a job definition making it available for job submissions.
+
+5. **Submits a Batch Job**: Submits a job.
+
+6. **Checks the status of the job**: Checks the status of the job.
+
+## ⚠ Important
+
+- Running this code might result in charges to your AWS account. For more details, see [AWS Pricing](https://aws.amazon.com/pricing/) and [Free Tier](https://aws.amazon.com/free/).
+- Running the tests might result in charges to your AWS account.
+- We recommend that you grant your code least privilege. At most, grant only the minimum permissions required to perform the task. For more information, see [Grant least privilege](https://docs.aws.amazon.com/IAM/latest/UserGuide/best-practices.html#grant-least-privilege).
+- This code is not tested in every AWS Region. For more information, see [AWS Regional Services](https://aws.amazon.com/about-aws/global-infrastructure/regional-product-services).
+
+## Code examples
+
+### Prerequisites
+
+To run these examples, you need:
+
+- Python 3.x installed.
+- Run `python pip install -r requirements.txt`
+- AWS credentials configured. For more information, see [Configuring the AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-files.html).
+
+#### Running the workflow
+
+To run this workflow, pull AWS tokens and run the command below:
+
+```bash
+python s3_batch_scenario.py
+```
+
+## Additional resources
+
+- [Amazon S3 Developer Guide](https://docs.aws.amazon.com/AmazonS3/latest/userguide/batch-ops-create-job.html)
+- [Amazon S3 API Reference](https://docs.aws.amazon.com/AmazonS3/latest/API/Welcome.html)
+- [boto3 Amazon S3 reference](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/s3.html)
+
+---
+
+© Amazon.com, Inc. or its affiliates. All Rights Reserved.
+
+SPDX-License-Identifier: Apache-2.0