feat(firehose): Add Python Basics scenario and Hello example

Author: scmacdon

.doc_gen/metadata/firehose_metadata.yaml

@@ -1,95 +1,205 @@
-# zexi 0.4.0
-firehose_PutRecord:
+firehose_Hello:
+  title: Hello &ADF;
+  title_abbrev: Hello &ADF;
+  synopsis: get started using &ADF;.
+  category: Hello
   languages:
-    Java:
+    Python:
       versions:
-        - sdk_version: 2
-          github: javav2/example_code/firehose
+        - sdk_version: 3
+          github: python/example_code/firehose
           excerpts:
             - description:
               snippet_tags:
-                - firehose.java2.put_record.main
+                - python.example_code.firehose.Hello
+  services:
+    firehose: {ListDeliveryStreams}
+firehose_CreateDeliveryStream:
+  title: Create a &ADF; delivery stream
+  title_abbrev: Create a delivery stream
+  synopsis: create an &ADF; delivery stream.
+  category: Actions
+  languages:
     Python:
       versions:
         - sdk_version: 3
           github: python/example_code/firehose
           excerpts:
             - description:
               snippet_tags:
-                - python.example_code.firehose.init
-                - python.example_code.firehose.put_record
-    SAP ABAP:
+                - python.example_code.firehose.FirehoseWrapper.decl
+                - python.example_code.firehose.CreateDeliveryStream
+  services:
+    firehose: {CreateDeliveryStream}
+firehose_DescribeDeliveryStream:
+  title: Describe a &ADF; delivery stream
+  title_abbrev: Describe a delivery stream
+  synopsis: describe an &ADF; delivery stream.
+  category: Actions
+  languages:
+    Python:
       versions:
-        - sdk_version: 1
-          github: sap-abap/services/frh
+        - sdk_version: 3
+          github: python/example_code/firehose
           excerpts:
             - description:
               snippet_tags:
-                - frh.abapv1.put_record
+                - python.example_code.firehose.FirehoseWrapper.decl
+                - python.example_code.firehose.DescribeDeliveryStream
   services:
-    firehose: {PutRecord}
-firehose_PutRecordBatch:
+    firehose: {DescribeDeliveryStream}
+firehose_TagDeliveryStream:
+  title: Tag a &ADF; delivery stream
+  title_abbrev: Tag a delivery stream
+  synopsis: tag an &ADF; delivery stream.
+  category: Actions
   languages:
-    Java:
+    Python:
       versions:
-        - sdk_version: 2
-          github: javav2/example_code/firehose
+        - sdk_version: 3
+          github: python/example_code/firehose
           excerpts:
             - description:
               snippet_tags:
-                - firehose.java2.put_batch_records.main
-    Rust:
+                - python.example_code.firehose.FirehoseWrapper.decl
+                - python.example_code.firehose.TagDeliveryStream
+  services:
+    firehose: {TagDeliveryStream}
+firehose_ListTagsForDeliveryStream:
+  title: List tags for a &ADF; delivery stream
+  title_abbrev: List tags for a delivery stream
+  synopsis: list tags for an &ADF; delivery stream.
+  category: Actions
+  languages:
+    Python:
       versions:
-        - sdk_version: 1
-          github: rustv1/examples/firehose
-          sdkguide:
+        - sdk_version: 3
+          github: python/example_code/firehose
           excerpts:
             - description:
               snippet_tags:
-                - firehose.rust.put_record_batch
+                - python.example_code.firehose.FirehoseWrapper.decl
+                - python.example_code.firehose.ListTagsForDeliveryStream
+  services:
+    firehose: {ListTagsForDeliveryStream}
+firehose_StartDeliveryStreamEncryption:
+  title: Start encryption on a &ADF; delivery stream
+  title_abbrev: Start delivery stream encryption
+  synopsis: start server-side encryption on an &ADF; delivery stream.
+  category: Actions
+  languages:
     Python:
       versions:
         - sdk_version: 3
           github: python/example_code/firehose
           excerpts:
             - description:
               snippet_tags:
-                - python.example_code.firehose.init
-                - python.example_code.firehose.put_record_batch
-    SAP ABAP:
+                - python.example_code.firehose.FirehoseWrapper.decl
+                - python.example_code.firehose.StartDeliveryStreamEncryption
+  services:
+    firehose: {StartDeliveryStreamEncryption}
+firehose_PutRecord:
+  title: Put a record to a &ADF; delivery stream
+  title_abbrev: Put a record
+  synopsis: put a record to an &ADF; delivery stream.
+  category: Actions
+  languages:
+    Python:
       versions:
-        - sdk_version: 1
-          github: sap-abap/services/frh
+        - sdk_version: 3
+          github: python/example_code/firehose
           excerpts:
             - description:
               snippet_tags:
-                - frh.abapv1.put_record_batch
+                - python.example_code.firehose.FirehoseWrapper.decl
+                - python.example_code.firehose.PutRecord
+  services:
+    firehose: {PutRecord}
+firehose_PutRecordBatch:
+  title: Put a batch of records to a &ADF; delivery stream
+  title_abbrev: Put a record batch
+  synopsis: put a batch of records to an &ADF; delivery stream.
+  category: Actions
+  languages:
+    Python:
+      versions:
+        - sdk_version: 3
+          github: python/example_code/firehose
+          excerpts:
+            - description:
+              snippet_tags:
+                - python.example_code.firehose.FirehoseWrapper.decl
+                - python.example_code.firehose.PutRecordBatch
   services:
     firehose: {PutRecordBatch}
-firehose_Scenario_PutRecords:
-  title: Use &FHlong; to process individual and batch records
-  title_abbrev: Put records to &FH;
-  synopsis: use &FH; to process individual and batch records.
-  category: Scenarios
+firehose_UpdateDestination:
+  title: Update destination of a &ADF; delivery stream
+  title_abbrev: Update destination
+  synopsis: update the destination of an &ADF; delivery stream.
+  category: Actions
+  languages:
+    Python:
+      versions:
+        - sdk_version: 3
+          github: python/example_code/firehose
+          excerpts:
+            - description:
+              snippet_tags:
+                - python.example_code.firehose.FirehoseWrapper.decl
+                - python.example_code.firehose.UpdateDestination
+  services:
+    firehose: {UpdateDestination}
+firehose_ListDeliveryStreams:
+  title: List &ADF; delivery streams
+  title_abbrev: List delivery streams
+  synopsis: list &ADF; delivery streams.
+  category: Actions
+  languages:
+    Python:
+      versions:
+        - sdk_version: 3
+          github: python/example_code/firehose
+          excerpts:
+            - description:
+              snippet_tags:
+                - python.example_code.firehose.FirehoseWrapper.decl
+                - python.example_code.firehose.ListDeliveryStreams
+  services:
+    firehose: {ListDeliveryStreams}
+firehose_DeleteDeliveryStream:
+  title: Delete a &ADF; delivery stream
+  title_abbrev: Delete a delivery stream
+  synopsis: delete an &ADF; delivery stream.
+  category: Actions
   languages:
-    Java:
+    Python:
       versions:
-        - sdk_version: 2
-          github: javav2/example_code/firehose
+        - sdk_version: 3
+          github: python/example_code/firehose
           excerpts:
-            - description: This example puts individual and batch records to &FH;.
+            - description:
               snippet_tags:
-                - firehose.java2.scenario.main
+                - python.example_code.firehose.FirehoseWrapper.decl
+                - python.example_code.firehose.DeleteDeliveryStream
+  services:
+    firehose: {DeleteDeliveryStream}
+firehose_Scenario:
+  title: Learn &ADF; basics
+  title_abbrev: Learn the basics
+  synopsis: learn the basics of &ADF; by creating a delivery stream and managing it.
+  category: Scenarios
+  languages:
     Python:
       versions:
         - sdk_version: 3
-          github: python/example_code/firehose/scenarios/firehose-put-actions
+          github: python/example_code/firehose
           excerpts:
-            - description: This script puts individual and batch records to &FH;.
-              snippet_files:
-                - python/example_code/firehose/scenarios/firehose-put-actions/firehose.py
-            - description: This file contains config for the above script.
-              snippet_files:
-                - python/example_code/firehose/scenarios/firehose-put-actions/config.py
+            - description: Create a Firehose wrapper class to manage operations.
+              snippet_tags:
+                - python.example_code.firehose.FirehoseWrapper.class
+            - description: Run an interactive scenario demonstrating Firehose basics.
+              snippet_tags:
+                - python.example_code.firehose.FirehoseScenario
   services:
-    firehose: {PutRecord, PutRecordBatch}
+    firehose: {CreateDeliveryStream, DescribeDeliveryStream, TagDeliveryStream, ListTagsForDeliveryStream, StartDeliveryStreamEncryption, PutRecord, PutRecordBatch, UpdateDestination, ListDeliveryStreams, DeleteDeliveryStream}

python/example_code/firehose/firehose_hello.py

@@ -0,0 +1,45 @@
+# Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+# SPDX-License-Identifier: Apache-2.0
+
+"""
+Purpose: Hello Amazon Data Firehose - Lists delivery streams in your account.
+"""
+
+# snippet-start:[python.example_code.firehose.Hello]
+import boto3
+from botocore.exceptions import ClientError
+
+
+def hello_firehose(firehose_client):
+    """
+    Use the AWS SDK for Python (Boto3) to create an Amazon Data Firehose client
+    and list delivery streams in your account. This example uses the default
+    settings specified in your shared credentials and config files.
+
+    :param firehose_client: A Boto3 Amazon Data Firehose client object.
+    """
+    print("Hello, Amazon Data Firehose! Let's list your delivery streams:\n")
+    try:
+        response = firehose_client.list_delivery_streams(Limit=10)
+        stream_names = response.get("DeliveryStreamNames", list())
+        if stream_names:
+            print(f"  Found {len(stream_names)} delivery stream(s):")
+            for name in stream_names:
+                print(f"    - {name}")
+            if response.get("HasMoreDeliveryStreams", False):
+                print(
+                    "\n  Note: There are additional delivery streams not shown."
+                )
+        else:
+            print("  No delivery streams found in the current region.")
+    except ClientError as err:
+        print(
+            f"  Couldn't list delivery streams. Error: "
+            f"{err.response['Error']['Code']}: {err.response['Error']['Message']}"
+        )
+        raise
+
+
+if __name__ == "__main__":
+    hello_firehose(boto3.client("firehose"))
+# snippet-end:[python.example_code.firehose.Hello]