FlowSummary
Contains the definition of a flow.
Contents
- arn
-
The Amazon Resource Name (ARN) of the flow.
Type: String
Pattern:
arn:aws:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:flow/[0-9a-zA-Z]{10}Required: Yes
- createdAt
-
The time at which the flow was created.
Type: Timestamp
Required: Yes
- id
-
The unique identifier of the flow.
Type: String
Pattern:
[0-9a-zA-Z]{10}Required: Yes
- name
-
The name of the flow.
Type: String
Pattern:
([0-9a-zA-Z][_-]?){1,100}Required: Yes
- status
-
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
DRAFTversion won't contain the latest changes for testing. Send a PrepareFlow request to package the latest changes into theDRAFTversion. -
Preparing – The flow is being prepared so that the
DRAFTversion contains the latest changes for testing. -
Prepared – The flow is prepared and the
DRAFTversion 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
validationsfield.
Type: String
Valid Values:
Failed | Prepared | Preparing | NotPreparedRequired: Yes
-
- updatedAt
-
The time at which the flow was last updated.
Type: Timestamp
Required: Yes
- version
-
The latest version of the flow.
Type: String
Length Constraints: Fixed length of 5.
Pattern:
DRAFTRequired: Yes
- description
-
A description of the flow.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 200.
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: