Skip to content

Commit f75fb0a

Browse files
committed
Remove unused file, update README in scenario folder.
1 parent a3ac787 commit f75fb0a

File tree

2 files changed

+13
-14
lines changed

2 files changed

+13
-14
lines changed

python/example_code/s3/scenarios/conditional_requests/.gitignore

Lines changed: 0 additions & 1 deletion
This file was deleted.

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

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11

2-
# Amazon S3 Object Lock Workflow for the SDK for Python (boto3)
2+
# Amazon S3 Conditional Requests Feature Scenario for the SDK for Python (boto3)
33

44
## Overview
55

6-
This example demonstrates how to use the AWS SDK for Python (boto3) to work with Amazon Simple Storage Service (Amazon S3) object locking features. The workflow shows how to create, update, view, and modify object locks, as well as how locked objects behave regarding requests to delete and overwrite.
6+
This example demonstrates how to use the AWS SDK for Python (boto3) to work with Amazon Simple Storage Service (Amazon S3) conditional request features. The scenario demonstrates how to add preconditions to S3 operations, and how those operations will succeed or fail based on the conditional requests.
77

8-
[Amazon S3 Object Lock](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lock.html) can help prevent Amazon S3 objects from being deleted or overwritten for a fixed amount of time or indefinitely. Object Lock can help meet regulatory requirements or protect against object changes or deletion.
8+
[Amazon S3 Conditional Requests](https://docs.aws.amazon.com/AmazonS3/latest/userguide/conditional-requests.html) are used to add preconditions to S3 read, copy, or write requests.
99

1010
## ⚠ Important
1111

@@ -24,25 +24,25 @@ To run these examples, you need:
2424
- Run `python pip install -r requirements.txt`
2525
- AWS credentials configured. For more information, see [Configuring the AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-files.html).
2626

27-
### Scenarios
27+
### Scenario
2828

29-
This example uses a workflow approach to demonstrate various aspects of S3 Object Locking. The workflow is divided into three stages:
29+
This example uses a feature scenario to demonstrate various aspects of S3 conditional requests. The scenario is divided into three stages:
3030

31-
1. **Deploy**: Create buckets with different object locking configurations, populate buckets with objects, and set object lock and retention policies.
32-
2. **Demo**: Explore S3 locking features by listing objects, attempting to delete or overwrite locked objects, and viewing retention and legal hold settings.
33-
3. **Clean**: Remove object locks and retention periods, delete all objects and buckets.
31+
1. **Setup**: Create test buckets and objects.
32+
2. **Conditional Reads and Writes**: Explore S3 conditional requests by listing objects, attempting to read or write with conditional requests, and viewing request results.
33+
3. **Clean**: Delete all objects and buckets.
3434

35-
#### Running the workflow
36-
To run this workflow, pull AWS tokens and run the command below:
35+
#### Running the scenario
36+
To run this feature scenario, run the command below from this directory:
3737

38-
```bash
39-
python main.py
38+
```
39+
python scenario.py
4040
```
4141

4242

4343
## Additional resources
4444

45-
- [Amazon S3 Developer Guide](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lock.html)
45+
- [Amazon S3 Developer Guide](https://docs.aws.amazon.com/AmazonS3/latest/userguide/conditional-requests.html)
4646
- [Amazon S3 API Reference](https://docs.aws.amazon.com/AmazonS3/latest/API/Welcome.html)
4747
- [boto3 Amazon S3 reference](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/s3.html)
4848

0 commit comments

Comments
 (0)