AgentsforBedrock / Client / prepare_flow

prepare_flow#

AgentsforBedrock.Client.prepare_flow(**kwargs)#

Prepares the DRAFT version of a flow so that it can be invoked. For more information, see Test a flow in Amazon Bedrock in the Amazon Bedrock User Guide.

See also: AWS API Documentation

Request Syntax

response = client.prepare_flow(
    flowIdentifier='string'
)
Parameters:

flowIdentifier (string) –

[REQUIRED]

The unique identifier of the flow.

Return type:

dict

Returns:

Response Syntax

{
    'id': 'string',
    'status': 'Failed'|'Prepared'|'Preparing'|'NotPrepared'
}

Response Structure

  • (dict) –

    • id (string) –

      The unique identifier of the flow.

    • status (string) –

      The status of the flow. When you submit this request, the status will be NotPrepared. If preparation succeeds, the status becomes Prepared. If it fails, the status becomes FAILED.

Exceptions