AgentsforBedrock / Client / list_flows

list_flows#

AgentsforBedrock.Client.list_flows(**kwargs)#

Returns a list of flows and information about each flow. For more information, see Manage a flow in Amazon Bedrock in the Amazon Bedrock User Guide.

See also: AWS API Documentation

Request Syntax

response = client.list_flows(
    maxResults=123,
    nextToken='string'
)
Parameters:

  • maxResults (integer) – The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.

  • nextToken (string) – If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.

Return type:

dict

Returns:

Response Syntax

{
    'flowSummaries': [
        {
            'arn': 'string',
            'createdAt': datetime(2015, 1, 1),
            'description': 'string',
            'id': 'string',
            'name': 'string',
            'status': 'Failed'|'Prepared'|'Preparing'|'NotPrepared',
            'updatedAt': datetime(2015, 1, 1),
            'version': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • flowSummaries (list) –

      A list, each member of which contains information about a flow.

      • (dict) –

        Contains the definition of a flow.

        • arn (string) –

          The Amazon Resource Name (ARN) of the flow.

        • createdAt (datetime) –

          The time at which the flow was created.

        • description (string) –

          A description of the flow.

        • id (string) –

          The unique identifier of the flow.

        • name (string) –

          The name of the flow.

        • status (string) –

          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.

        • updatedAt (datetime) –

          The time at which the flow was last updated.

        • version (string) –

          The latest version of the flow.

    • nextToken (string) –

      If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.

Exceptions