Metadata updates.

Author: rlhagerm

.doc_gen/metadata/s3_metadata.yaml

@@ -294,6 +294,11 @@ s3_CopyObject:
               snippet_tags:
                 - python.example_code.s3.helper.ObjectWrapper
                 - python.example_code.s3.CopyObject
+            - description: Copy an object using a conditional request.
+              genai: some
+              snippet_tags:
+                - python.example_code.s3.helper.S3ConditionalRequests
+                - python.example_code.s3.CopyObjectConditional
     Ruby:
       versions:
         - sdk_version: 3
@@ -872,6 +877,11 @@ s3_GetObject:
               snippet_tags:
                 - python.example_code.s3.helper.ObjectWrapper
                 - python.example_code.s3.GetObject
+            - description: Get an object using a conditional request.
+              genai: some
+              snippet_tags:
+                - python.example_code.s3.helper.S3ConditionalRequests
+                - python.example_code.s3.GetObjectConditional
     JavaScript:
       versions:
         - sdk_version: 3
@@ -1510,6 +1520,11 @@ s3_PutObject:
               snippet_tags:
                 - python.example_code.s3.helper.ObjectWrapper
                 - python.example_code.s3.PutObject
+            - description: Upload an object using a conditional request.
+              genai: some
+              snippet_tags:
+                - python.example_code.s3.helper.S3ConditionalRequests
+                - python.example_code.s3.PutObjectConditional
     Rust:
       versions:
         - sdk_version: 1
@@ -3454,6 +3469,28 @@ s3_Scenario_DeleteAllObjects:
                 - javascriptv3/example_code/s3/scenarios/delete-all-objects.js
   services:
     s3: {DeleteObjects, ListObjectsV2}
+s3_Scenario_ConditionalRequests:
+  title: Make &S3; conditional requests using an &AWS; SDK.
+  title_abbrev: Make conditional requests
+  synopsis: add preconditions to &S3; requests.
+  category: Scenarios
+  languages:
+    Python:
+      versions:
+        - sdk_version: 3
+          github: python/example_code/s3/scenarios/conditional_requests
+          sdkguide:
+          excerpts:
+            - description: Run an interactive scenario demonstrating &S3; conditional requests.
+              genai: some
+              snippet_tags:
+                - python.example_code.s3.S3ConditionalRequests.scenario
+            - description: A wrapper class that defines the conditional request operations.
+              genai: some
+              snippet_tags:
+                - python.example_code.s3.S3ConditionalRequests.wrapper
+  services:
+    s3: {GetObject, PutObject, CopyObject}
 s3_Scenario_ExpressBasics:
   title: Learn the basics of Amazon S3 Express One Zone with an &AWS; SDK
   title_abbrev: Learn the basics of S3 Express One Zone

python/example_code/s3/scenarios/conditional_requests/s3_conditional_requests.py

@@ -1,6 +1,8 @@
 # Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 # SPDX-License-Identifier: Apache-2.0
 
+# snippet-start:[python.example_code.s3.S3ConditionalRequests.wrapper]
+
 import boto3
 import logging
 
@@ -10,6 +12,7 @@
 logger = logging.getLogger(__name__)
 
 
+# snippet-start:[python.example_code.s3.helper.S3ConditionalRequests]
 class S3ConditionalRequests:
     """Encapsulates S3 conditional request operations."""
 
@@ -24,6 +27,8 @@ def from_client(cls):
         s3_client = boto3.client("s3")
         return cls(s3_client)
 
+    # snippet-end:[python.example_code.s3.helper.S3ConditionalRequests]
+
     # snippet-start:[python.example_code.s3.GetObjectConditional]
 
     def get_object_conditional(
@@ -134,3 +139,4 @@ def copy_object_conditional(
                 raise
 
     # snippet-end:[python.example_code.s3.CopyObjectConditional]
+# snippet-end:[python.example_code.s3.S3ConditionalRequests.wrapper]

python/example_code/s3/scenarios/conditional_requests/scenario.py

@@ -1,6 +1,7 @@
 # Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 # SPDX-License-Identifier: Apache-2.0
 
+# snippet-start:[python.example_code.s3.S3ConditionalRequests.scenario]
 """
 Purpose
 
@@ -283,3 +284,4 @@ def run_scenario(self):
         S3ConditionalRequests.from_client(), boto3.client("s3")
     )
     scenario.run_scenario()
+# snippet-end:[python.example_code.s3.S3ConditionalRequests.scenario]

workflows/s3_conditional_requests/SPECIFICATION.md

@@ -33,7 +33,7 @@ todo
 
 ```
 - Amazon S3 objects created in the scenario:
-  - Three test files in the source bucket, using a name prefix provided by the user.
+  - One test file in the source bucket.
 
 Example:
 
@@ -74,12 +74,16 @@ todo
 ---
 
 ## Errors
-
-| action                | Error | Handling |
-|-----------------------|-------|----------|
-| `GetObject`           | todo  | todo     |
-| `CopyObject`          | todo  | todo     |
-| `PutObject`           | todo  | todo     |
+The PreconditionFailed exceptions are part of the flow of this scenario. After a success or failure,
+the user can print the contents of the buckets to see the result.
+
+| action       | Error                 | Handling                                   |
+|--------------|-----------------------|--------------------------------------------|
+| `GetObject`  | PreconditionFailed    | Notify the user and do not print contents. |
+| `GetObject`  | ObjectNotModified 304 | Notify the user and do not print contents. |
+| `CopyObject` | PreconditionFailed    | Notify the user of the failure.            |
+| `CopyObject` | ObjectNotModified 304 | Notify the user of the failure.            |
+| `PutObject`  | PreconditionFailed    | Notify the user of the failure.            |
 
 
 ---