Amazon Bedrock playlist flow (#7358)

Co-authored-by: Christopher Rees <[email protected]>
Co-authored-by: Rachel Hagerman <[email protected]>

Author: 3 people

.doc_gen/metadata/bedrock-agent_metadata.yaml

@@ -185,6 +185,8 @@ bedrock-agent_PrepareAgent:
                 - python.example_code.bedrock-agent.PrepareAgent
   services:
     bedrock-agent: {PrepareAgent}
+
+
 bedrock-agent_GettingStartedWithBedrockAgents:
   title: An end-to-end example showing how to create and invoke &BRA; using an &AWS; SDK
   title_abbrev: Create and invoke an agent
@@ -209,3 +211,225 @@ bedrock-agent_GettingStartedWithBedrockAgents:
   services:
     bedrock-agent: {CreateAgent, CreateAgentActionGroup, CreateAgentAlias, DeleteAgent, DeleteAgentAlias, GetAgent, ListAgentActionGroups,
                     ListAgents, ListAgentKnowledgeBases, PrepareAgent}
+    
+
+
+bedrock-agent_GettingStartedWithBedrockFlows:
+  title: An end-to-end example showing how to create and invoke an Amazon Bedrock flow using an &AWS; SDK
+  title_abbrev: Create and invoke a flow
+  synopsis_list:
+    - Create an execution role for the flow.
+    - Create the flow.
+    - Deploy the fully configured flow.
+    - Invoke the flow with user-provided prompts.
+    - Delete all created resources.
+  category: Scenarios
+  languages:
+    Python:
+      versions:
+        - sdk_version: 3
+          github: python/example_code/bedrock-agent
+          excerpts:
+            - description: Generates a music playlist based on user-specified genre and number of songs.
+              snippet_tags:
+                - python.example_code.bedrock-agent-runtime.Scenario_GettingStartedBedrockFlows
+                - python.example_code.bedrock-agent-runtime.flow_invoke_flow
+                - python.example_code.bedrock-agent-runtime.run_playlist_flow
+                - python.example_code.bedrock-agent-runtime.Scenario_GettingStartedBedrockFlows_iam_role
+
+  services:
+    bedrock-agent: {CreateFlow, CreateFlowAlias, CreateFlowVersion, DeleteFlow, DeleteFlowVersion, DeleteFlowAlias, GetFlow, GetFlowAlias,
+                    GetFlowVersion, PrepareFlow}
+    bedrock-agent-runtime: {InvokeFlow}
+
+
+bedrock-agent_CreateFlow:
+  languages:
+    Python:
+      versions:
+        - sdk_version: 3
+          github: python/example_code/bedrock-agent
+          excerpts:
+            - description: Create an Amazon Bedrock flow.
+              snippet_tags:
+                - python.example_code.bedrock-agent.create_flow
+  services:
+    bedrock-agent: {CreateFlow}
+
+bedrock-agent_PrepareFlow:
+  languages:
+    Python:
+      versions:
+        - sdk_version: 3
+          github: python/example_code/bedrock-agent
+          excerpts:
+            - description: Prepare an Amazon Bedrock flow.
+              snippet_tags:
+                - python.example_code.bedrock-agent.prepare_flow
+  services:
+    bedrock-agent: {PrepareFlow}
+
+bedrock-agent_UpdateFlow:
+  languages:
+    Python:
+      versions:
+        - sdk_version: 3
+          github: python/example_code/bedrock-agent
+          excerpts:
+            - description: Update an Amazon Bedrock Flow.
+              snippet_tags:
+                - python.example_code.bedrock-agent.update_flow
+  services:
+    bedrock-agent: {UpdateFlow}
+
+bedrock-agent_DeleteFlow:
+  languages:
+    Python:
+      versions:
+        - sdk_version: 3
+          github: python/example_code/bedrock-agent
+          excerpts:
+            - description: Delete an Amazon Bedrock flow.
+              snippet_tags:
+                - python.example_code.bedrock-agent.delete_flow
+  services:
+    bedrock-agent: {DeleteFlow}
+
+bedrock-agent_GetFlow:
+  languages:
+    Python:
+      versions:
+        - sdk_version: 3
+          github: python/example_code/bedrock-agent
+          excerpts:
+            - description: Get an Amazon Bedrock flow.
+              snippet_tags:
+                - python.example_code.bedrock-agent.get_flow
+  services:
+    bedrock-agent: {GetFlow}
+
+bedrock-agent_ListFlows:
+  languages:
+    Python:
+      versions:
+        - sdk_version: 3
+          github: python/example_code/bedrock-agent
+          excerpts:
+            - description: List Amazon Bedrock flows.
+              snippet_tags:
+                - python.example_code.bedrock-agent.list_flows
+
+  services:
+    bedrock-agent: {ListFlows}
+
+bedrock-agent_CreateFlowAlias:
+  languages:
+    Python:
+      versions:
+        - sdk_version: 3
+          github: python/example_code/bedrock-agent
+          excerpts:
+            - description: Create an alias for an Amazon Bedrock flow.
+              snippet_tags:
+                - python.example_code.bedrock-agent.create_flow_alias
+
+  services:
+    bedrock-agent: {CreateFlowAlias}
+
+bedrock-agent_UpdateFlowAlias:
+  languages:
+    Python:
+      versions:
+        - sdk_version: 3
+          github: python/example_code/bedrock-agent
+          excerpts:
+            - description: Update an alias for an Amazon Bedrock flow.
+              snippet_tags:
+                - python.example_code.bedrock-agent.update_flow_alias
+
+  services:
+    bedrock-agent: {UpdateFlowAlias}
+
+bedrock-agent_DeleteFlowAlias:
+  languages:
+    Python:
+      versions:
+        - sdk_version: 3
+          github: python/example_code/bedrock-agent
+          excerpts:
+            - description: Delete an alias for an Amazon Bedrock flow.
+              snippet_tags:
+                - python.example_code.bedrock-agent.delete_flow_alias
+
+  services:
+    bedrock-agent: {DeleteFlowAlias}
+
+bedrock-agent_ListFlowAliases:
+  languages:
+    Python:
+      versions:
+        - sdk_version: 3
+          github: python/example_code/bedrock-agent
+          excerpts:
+            - description: List the aliases for an Amazon Bedrock flow.
+              snippet_tags:
+                - python.example_code.bedrock-agent.list_flow_aliases
+
+  services:
+    bedrock-agent: {ListFlowAliases}
+
+bedrock-agent_CreateFlowVersion:
+  languages:
+    Python:
+      versions:
+        - sdk_version: 3
+          github: python/example_code/bedrock-agent
+          excerpts:
+            - description: Create a version of an Amazon Bedrock flow.
+              snippet_tags:
+                - python.example_code.bedrock-agent.create_flow_version
+
+  services:
+    bedrock-agent: {CreateFlowVersion}
+
+bedrock-agent_GetFlowVersion:
+  languages:
+    Python:
+      versions:
+        - sdk_version: 3
+          github: python/example_code/bedrock-agent
+          excerpts:
+            - description: Get a version of an Amazon Bedrock flow.
+              snippet_tags:
+                - python.example_code.bedrock-agent.get_flow_version
+
+  services:
+    bedrock-agent: {GetFlowVersion}
+
+bedrock-agent_DeleteFlowVersion:
+  languages:
+    Python:
+      versions:
+        - sdk_version: 3
+          github: python/example_code/bedrock-agent
+          excerpts:
+            - description: Delete a version of an Amazon Bedrock flow.
+              snippet_tags:
+                - python.example_code.bedrock-agent.delete_flow_version
+
+  services:
+    bedrock-agent: {DeleteFlowVersion}
+
+bedrock-agent_ListFlowVersions:
+  languages:
+    Python:
+      versions:
+        - sdk_version: 3
+          github: python/example_code/bedrock-agent
+          excerpts:
+            - description: List the versions of an Amazon Bedrock flow.
+              snippet_tags:
+                - python.example_code.bedrock-agent.list_flow_versions
+
+  services:
+    bedrock-agent: {ListFlowVersions}

python/example_code/bedrock-agent/README.md

@@ -48,13 +48,31 @@ Code excerpts that show you how to call individual service functions.
 - [ListAgentKnowledgeBases](bedrock_agent_wrapper.py#L237)
 - [ListAgents](bedrock_agent_wrapper.py#L185)
 - [PrepareAgent](bedrock_agent_wrapper.py#L266)
+- [InvokeFlow](flows/run_flow.py#L23)
+- [CreateFlow](flows/flow.py#L18) 
+- [PrepareFlow](flows/flow.py#L58) 
+- [UpdateFlow](flows/flow.py#L112)
+- [DeleteFlow](flows/flow.py#L156)
+- [GetFlow](flows/flow.py#L192)  
+- [ListFlows](flows/flow.py#L229)
+- [CreateFlowVersion](flows/flow_version.py#L18) 
+- [GetFlowVersion](flows/flow_version.py#L54) 
+- [DeleteFlowVersion](flows/flow_version.py#L91) 
+- [ListFlowVersions](flows/flow_version.py#L128) 
+- [CreateFlowAlias](flows/flow_alias.py#L15) 
+- [UpdateFlowAlias](flows/flow_alias.py#L55) 
+- [DeleteFlowAlias](flows/flow_alias.py#L98) 
+- [ListFlowAliases](flows/flow_alias.py#L132) 
+
+
 
 ### Scenarios
 
 Code examples that show you how to accomplish a specific task by calling multiple
 functions within the same service.
 
 - [Create and invoke an agent](scenario_get_started_with_agents.py)
+- [Create and invoke a flow](flows/playlist_flow.py)
 
 
 <!--custom.examples.start-->
@@ -95,6 +113,37 @@ python scenario_get_started_with_agents.py
 <!--custom.scenarios.bedrock-agent_GettingStartedWithBedrockAgents.start-->
 <!--custom.scenarios.bedrock-agent_GettingStartedWithBedrockAgents.end-->
 
+
+#### Create and invoke a flow
+
+Shows how to create a simple flow that generates music playlists.
+The flow includes a prompt node that generates a playlist for a chosen genre
+and number of songs. The example creates the nodes and permissions
+for the flow.
+
+Start the example by running the following at a command prompt:
+
+```
+python flows/playlist_flow.py
+```
+When prompted, enter the genre of music and the number of songs you want
+in the playlist.
+Optionally, the script can delete the resources that it creates. If you want to use the flow later, such as in the Amazon Bedrock console, enter `n` when the script prompts you to delete resources. Note that you will then need to manually delete the resources.
+
+
+
+#### List flows
+
+Shows how to List Amazon Bedrock flows, versions of a flow, and aliases of a flow.
+
+Start the example by running the following at a command prompt:
+
+```
+python flows/list_flows.py
+```
+The example first lists the flows in the current AWS Region. It
+then prompts for a flow ID, which you can get from the list of flows. Finally, the example lists the flow versions and flow aliases for the flow ID that you entered.
+
 ### Tests
 
 ⚠ Running tests might result in charges to your AWS account.