Skip to content

Bedrock Agent  >  Structures  >  FlowSummary

FlowSummary

Structure Class

FlowSummary dataclass

Contains the definition of a flow.

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.

description class-attribute instance-attribute 
description: str | None = None

A description of the flow.

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. 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 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 request and check the error message in the validations field.

updated_at instance-attribute 
updated_at: datetime

The time at which the flow was last updated.

version instance-attribute 
version: str

The latest version of the flow.