Skip to content

Commit 46eb783

Browse files
committed
chore(README): Add README for S3 Batch Python
1 parent d06f787 commit 46eb783

File tree

1 file changed

+56
-0
lines changed
  • python/example_code/s3/scenarios/batch

1 file changed

+56
-0
lines changed
Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
# Amazon S3 Batch for the SDK for Python (boto3)
2+
3+
## Overview
4+
5+
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.
6+
7+
Here are the top six service operations this scenario covers.
8+
9+
1. **Create an AWS Batch computer environment**: Creates an AWS Batch computer environment.
10+
11+
2. **Sets up a job queue**: Creates a job queue that will manage the submission of jobs.
12+
13+
3. **Creates a job definition**: Creates a job definition that specifies how the jobs should be executed.
14+
15+
4. **Registers a Job Definition**: Registers a job definition making it available for job submissions.
16+
17+
5. **Submits a Batch Job**: Submits a job.
18+
19+
6. **Checks the status of the job**: Checks the status of the job.
20+
21+
## ⚠ Important
22+
23+
- 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/).
24+
- Running the tests might result in charges to your AWS account.
25+
- 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).
26+
- 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).
27+
28+
## Code examples
29+
30+
### Prerequisites
31+
32+
To run these examples, you need:
33+
34+
- Python 3.x installed.
35+
- Run `python pip install -r requirements.txt`
36+
- AWS credentials configured. For more information, see [Configuring the AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-files.html).
37+
38+
#### Running the workflow
39+
40+
To run this workflow, pull AWS tokens and run the command below:
41+
42+
```bash
43+
python s3_batch.py
44+
```
45+
46+
## Additional resources
47+
48+
- [Amazon S3 Developer Guide](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lock.html)
49+
- [Amazon S3 API Reference](https://docs.aws.amazon.com/AmazonS3/latest/API/Welcome.html)
50+
- [boto3 Amazon S3 reference](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/s3.html)
51+
52+
---
53+
54+
© Amazon.com, Inc. or its affiliates. All Rights Reserved.
55+
56+
SPDX-License-Identifier: Apache-2.0

0 commit comments

Comments
 (0)