Bedrock Agent  >  Operations  >  update_flow

update_flow

Operation

update_flow async

update_flow(input: UpdateFlowInput, plugins: list[Plugin] | None = None) -> UpdateFlowOutput

Modifies a flow. Include both fields that you want to keep and fields that you want to change. For more information, see How it works and Create a flow in Amazon Bedrock in the Amazon Bedrock User Guide.

Parameters:

Name	Type	Description	Default
input	UpdateFlowInput	An instance of UpdateFlowInput.	required
plugins	list[Plugin] | None	A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.	None

Returns:

Type	Description
UpdateFlowOutput	An instance of UpdateFlowOutput.

Input

UpdateFlowInput dataclass

Dataclass for UpdateFlowInput structure.

Attributes

customer_encryption_key_arn class-attribute instance-attribute

customer_encryption_key_arn: str | None = None

The Amazon Resource Name (ARN) of the KMS key to encrypt the flow.

definition class-attribute instance-attribute

definition: FlowDefinition | None = field(repr=False, default=None)

A definition of the nodes and the connections between the nodes in the flow.

description class-attribute instance-attribute

description: str | None = None

A description for the flow.

execution_role_arn class-attribute instance-attribute

execution_role_arn: str | None = None

The Amazon Resource Name (ARN) of the service role with permissions to create and manage a flow. For more information, see Create a service role for flows in Amazon Bedrock in the Amazon Bedrock User Guide.

flow_identifier class-attribute instance-attribute

flow_identifier: str | None = None

The unique identifier of the flow.

name class-attribute instance-attribute

name: str | None = None

A name for the flow.

Output

UpdateFlowOutput dataclass

Dataclass for UpdateFlowOutput structure.

Attributes

arn instance-attribute

arn: str

The Amazon Resource Name (ARN) of the flow.

created_at instance-attribute

created_at: datetime

The time at which the flow was created.

customer_encryption_key_arn class-attribute instance-attribute

customer_encryption_key_arn: str | None = None

The Amazon Resource Name (ARN) of the KMS key that the flow was encrypted with.

definition class-attribute instance-attribute

definition: FlowDefinition | None = field(repr=False, default=None)

A definition of the nodes and the connections between nodes in the flow.

description class-attribute instance-attribute

description: str | None = None

The description of the flow.

execution_role_arn instance-attribute

execution_role_arn: str

The Amazon Resource Name (ARN) of the service role with permissions to create a flow. For more information, see Create a service role for flows in Amazon Bedrock in the Amazon Bedrock User Guide.

id instance-attribute

id: str

The unique identifier of the flow.

name instance-attribute

name: str

The name of the flow.

status instance-attribute

status: FlowStatus

The status of the flow. When you submit this request, the status will be NotPrepared. If updating fails, the status becomes Failed.

updated_at instance-attribute

updated_at: datetime

The time at which the flow was last updated.

version instance-attribute

version: str

The version of the flow. When you update a flow, the version updated is the DRAFT version.