Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1475719557.8 KB

Creates a prompt flow that you can use to send an input through various steps to yield an output. Configure nodes, each of which corresponds to a step of the flow, and create connections between the nodes to create paths to different outputs. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/flows-how-it-works.html">How it works</a> and <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/flows-create.html">Create a flow in Amazon Bedrock</a> in the Amazon Bedrock User Guide.

post/flows/

Request body

namestring required

A name for the flow.

descriptionstring

A description for the flow.

executionRoleArnstring required

The Amazon Resource Name (ARN) of the service role with permissions to create and manage a flow. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/flows-permissions.html">Create a service role for flows in Amazon Bedrock</a> in the Amazon Bedrock User Guide.

customerEncryptionKeyArnstring

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

clientTokenstring

A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html">Ensuring idempotency</a>.

tagsobject

Any tags that you want to attach to the flow. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/tagging.html">Tagging resources in Amazon Bedrock</a>.

Response

Success

namestring required

The name of the flow.

descriptionstring

The description of the flow.

executionRoleArnstring required

The Amazon Resource Name (ARN) of the service role with permissions to create a flow. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/flows-permissions.html">Create a service role for flows in Amazon Bedrock</a> in the Amazon Bedrock User Guide.

customerEncryptionKeyArnstring

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

idstring required

The unique identifier of the flow.

arnstring required

The Amazon Resource Name (ARN) of the flow.

status'Failed' | 'Prepared' | 'Preparing' | 'NotPrepared' required

The status of the flow. When you submit this request, the status will be <code>NotPrepared</code>. If creation fails, the status becomes <code>Failed</code>.

createdAtstring date-time required

The time at which the flow was created.

updatedAtstring date-time required

The time at which the flow was last updated.

versionstring required

The version of the flow. When you create a flow, the version created is the <code>DRAFT</code> version.