AWS cli documentation change
Summary
Updated AWS CLI version reference from 2.28.8 to 2.28.11. Added documentation for flow properties including encryption, execution role, status tracking, and detailed node configuration structures. Restructured connection and node definitions with expanded configuration options.
Security assessment
Added 'customerEncryptionKeyArn' field documentation about KMS encryption for flows, which is a security feature. However, there's no evidence of addressing a specific security vulnerability. The executionRoleArn documentation relates to permissions but doesn't indicate a security fix.
Diff
diff --git a/cli/latest/reference/bedrock-agent/get-flow.md b/cli/latest/reference/bedrock-agent/get-flow.md index 6bcc5ccfd..48fe3d8ec 100644 --- a//cli/latest/reference/bedrock-agent/get-flow.md +++ b//cli/latest/reference/bedrock-agent/get-flow.md @@ -15 +15 @@ - * [AWS CLI 2.28.8 Command Reference](../../index.html) » + * [AWS CLI 2.28.11 Command Reference](../../index.html) » @@ -196,0 +197,20 @@ Disable automatically prompt for CLI input parameters. +name -> (string) + +> The name of the flow. + +description -> (string) + +> The description of the flow. + +executionRoleArn -> (string) + +> The Amazon Resource Name (ARN) of the service role with permissions to create a flow. For more information, see [Create a service row for flows](https://docs.aws.amazon.com/bedrock/latest/userguide/flows-permissions.html) in the Amazon Bedrock User Guide. + +customerEncryptionKeyArn -> (string) + +> The Amazon Resource Name (ARN) of the KMS key that the flow is encrypted with. + +id -> (string) + +> The unique identifier of the flow. + @@ -200,0 +221,11 @@ arn -> (string) +status -> (string) + +> The status of the flow. The following statuses are possible: +> +> * NotPrepared – The flow has been created or updated, but hasn’t been prepared. If you just created the flow, you can’t test it. If you updated the flow, the `DRAFT` version won’t contain the latest changes for testing. Send a [PrepareFlow](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_PrepareFlow.html) request to package the latest changes into the `DRAFT` version. +> * Preparing – The flow is being prepared so that the `DRAFT` version contains the latest changes for testing. +> * Prepared – The flow is prepared and the `DRAFT` version contains the latest changes for testing. +> * Failed – The last API operation that you invoked on the flow failed. Send a [GetFlow](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_GetFlow.html) request and check the error message in the `validations` field. +> + + @@ -205 +236 @@ createdAt -> (timestamp) -customerEncryptionKeyArn -> (string) +updatedAt -> (timestamp) @@ -207 +238,5 @@ customerEncryptionKeyArn -> (string) -> The Amazon Resource Name (ARN) of the KMS key that the flow is encrypted with. +> The time at which the flow was last updated. + +version -> (string) + +> The version of the flow for which information was retrieved. @@ -213 +248 @@ definition -> (structure) -> connections -> (list) +> nodes -> (list) @@ -215 +250 @@ definition -> (structure) ->> An array of connection definitions in the flow. +>> An array of node definitions in the flow. @@ -219,29 +254 @@ definition -> (structure) ->>> Contains information about a connection between two nodes in the flow. ->>> ->>> configuration -> (tagged union structure) ->>> ->>>> The configuration of the connection. ->>>> ->>>> ### Note ->>>> ->>>> This is a Tagged Union structure. Only one of the following top level keys can be set: `conditional`, `data`. ->>>> ->>>> conditional -> (structure) ->>>> ->>>>> The configuration of a connection originating from a Condition node. ->>>>> ->>>>> condition -> (string) ->>>>> ->>>>>> The condition that triggers this connection. For more information about how to write conditions, see the **Condition** node type in the [Node types](https://docs.aws.amazon.com/bedrock/latest/userguide/node-types.html) topic in the Amazon Bedrock User Guide. ->>>> ->>>> data -> (structure) ->>>> ->>>>> The configuration of a connection originating from a node that isn’t a Condition node. ->>>>> ->>>>> sourceOutput -> (string) ->>>>> ->>>>>> The name of the output in the source node that the connection begins from. ->>>>> ->>>>> targetInput -> (string) ->>>>> ->>>>>> The name of the input in the target node that the connection ends at. +>>> Contains configurations about a node in the flow. @@ -251,9 +258 @@ definition -> (structure) ->>>> A name for the connection that you can reference. ->>> ->>> source -> (string) ->>> ->>>> The node that the connection starts at. ->>> ->>> target -> (string) ->>> ->>>> The node that the connection ends at. +>>>> A name for the node. @@ -263,9 +262 @@ definition -> (structure) ->>>> Whether the source node that the connection begins from is a condition node (`Conditional` ) or not (`Data` ). -> -> nodes -> (list) -> ->> An array of node definitions in the flow. ->> ->> (structure) ->> ->>> Contains configurations about a node in the flow. +>>>> The type of node. This value must match the name of the key that you provide in the configuration you provide in the `FlowNodeConfiguration` field. @@ -279,49 +270 @@ definition -> (structure) ->>>> This is a Tagged Union structure. Only one of the following top level keys can be set: `agent`, `collector`, `condition`, `inlineCode`, `input`, `iterator`, `knowledgeBase`, `lambdaFunction`, `lex`, `loop`, `loopController`, `loopInput`, `output`, `prompt`, `retrieval`, `storage`. ->>>> ->>>> agent -> (structure) ->>>> ->>>>> Contains configurations for an agent node in your flow. Invokes an alias of an agent and returns the response. ->>>>> ->>>>> agentAliasArn -> (string) ->>>>> ->>>>>> The Amazon Resource Name (ARN) of the alias of the agent to invoke. ->>>> ->>>> collector -> (structure) ->>>> ->>>>> Contains configurations for a collector node in your flow. Collects an iteration of inputs and consolidates them into an array of outputs. ->>>> ->>>> condition -> (structure) ->>>> ->>>>> Contains configurations for a condition node in your flow. Defines conditions that lead to different branches of the flow. ->>>>> ->>>>> conditions -> (list) ->>>>> ->>>>>> An array of conditions. Each member contains the name of a condition and an expression that defines the condition. ->>>>>> ->>>>>> (structure) ->>>>>> ->>>>>>> Defines a condition in the condition node. ->>>>>>> ->>>>>>> expression -> (string) ->>>>>>> ->>>>>>>> Defines the condition. You must refer to at least one of the inputs in the condition. For more information, expand the Condition node section in [Node types in prompt flows](https://docs.aws.amazon.com/bedrock/latest/userguide/flows-how-it-works.html#flows-nodes) . ->>>>>>> ->>>>>>> name -> (string) ->>>>>>> ->>>>>>>> A name for the condition that you can reference. ->>>> ->>>> inlineCode -> (structure) ->>>> ->>>>> Contains configurations for an inline code node in your flow. Inline code nodes let you write and execute code directly within your flow, enabling data transformations, custom logic, and integrations without needing an external Lambda function. ->>>>> ->>>>> code -> (string) ->>>>> ->>>>>> The code that’s executed in your inline code node. The code can access input data from previous nodes in the flow, perform operations on that data, and produce output that can be used by other nodes in your flow. ->>>>>> ->>>>>> The code must be valid in the programming `language` that you specify. ->>>>> ->>>>> language -> (string) ->>>>> ->>>>>> The programming language used by your inline code node. ->>>>>> ->>>>>> The code must be valid in the programming `language` that you specify. Currently, only Python 3 (`Python_3` ) is supported. +>>>> This is a Tagged Union structure. Only one of the following top level keys can be set: `input`, `output`, `knowledgeBase`, `condition`, `lex`, `prompt`, `lambdaFunction`, `storage`, `agent`, `retrieval`, `iterator`, `collector`, `inlineCode`, `loop`, `loopInput`, `loopController`. @@ -333 +276 @@ definition -> (structure) ->>>> iterator -> (structure) +>>>> output -> (structure) @@ -335,3 +278 @@ definition -> (structure) ->>>>> Contains configurations for an iterator node in your flow. Takes an input that is an array and iteratively sends each item of the array as an output to the following node. The size of the array is also returned in the output. ->>>>> ->>>>> The output flow node at the end of the flow iteration will return a response for each member of the array. To return only one response, you can include a collector node downstream from the iterator node. +>>>>> Contains configurations for an output flow node in your flow. The last node in the flow. `outputs` can’t be specified for this node. @@ -342,0 +284,8 @@ definition -> (structure) +>>>>> knowledgeBaseId -> (string) +>>>>> +>>>>>> The unique identifier of the knowledge base to query. +>>>>> +>>>>> modelId -> (string) +>>>>> +>>>>>> The unique identifier of the model or [inference profile](https://docs.aws.amazon.com/bedrock/latest/userguide/cross-region-inference.html) to use to generate a response from the query results. Omit this field if you want to return the retrieved results as an array. +>>>>> @@ -354,0 +304,12 @@ definition -> (structure) +>>>>> numberOfResults -> (integer) +>>>>> +>>>>>> The number of results to retrieve from the knowledge base. +>>>>> +>>>>> promptTemplate -> (structure) +>>>>> +>>>>>> A custom prompt template to use with the knowledge base for generating responses. +>>>>>> +>>>>>> textPromptTemplate -> (string) +>>>>>> +>>>>>>> The text of the prompt template. +>>>>> @@ -366,0 +328,8 @@ definition -> (structure) +>>>>>>> temperature -> (float) +>>>>>>> +>>>>>>>> Controls the randomness of the response. Choose a lower value for more predictable outputs and a higher value for more surprising outputs. +>>>>>>> +>>>>>>> topP -> (float) +>>>>>>> +>>>>>>>> The percentage of most-likely candidates that the model considers for the next token. +>>>>>>> @@ -376,18 +344,0 @@ definition -> (structure)