Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1475719557.8 KB

Retrieves information about a flow. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/flows-manage.html">Manage a flow in Amazon Bedrock</a> in the Amazon Bedrock User Guide.

get/flows/{flowIdentifier}/

Path parameters

flowIdentifierstring required

The unique identifier of the flow.

Query parameters

includedData'ALL_DATA' | 'METADATA_ONLY'

Controls the scope of data returned. Set to <code>METADATA_ONLY</code> to return only resource metadata. Set to <code>ALL_DATA</code> or omit this field to return the full response.

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 row for flows</a> in the Amazon Bedrock User Guide.

customerEncryptionKeyArnstring

The Amazon Resource Name (ARN) of the KMS key that the flow is encrypted 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
<p>The status of the flow. The following statuses are possible:</p> <ul> <li> <p>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 <code>DRAFT</code> version won't contain the latest changes for testing. Send a <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_PrepareFlow.html">PrepareFlow</a> request to package the latest changes into the <code>DRAFT</code> version.</p> </li> <li> <p>Preparing – The flow is being prepared so that the <code>DRAFT</code> version contains the latest changes for testing.</p> </li> <li> <p>Prepared – The flow is prepared and the <code>DRAFT</code> version contains the latest changes for testing.</p> </li> <li> <p>Failed – The last API operation that you invoked on the flow failed. Send a <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_GetFlow.html">GetFlow</a> request and check the error message in the <code>validations</code> field.</p> </li> </ul>
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 for which information was retrieved.