ListFlywheelIterationHistory - Amazon Comprehend API Reference


Information about the history of a flywheel iteration. For more information about flywheels, see Flywheel overview in the Amazon Comprehend Developer Guide.

Request Syntax

{ "Filter": { "CreationTimeAfter": number, "CreationTimeBefore": number }, "FlywheelArn": "string", "MaxResults": number, "NextToken": "string" }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.


Filter the flywheel iteration history based on creation time.

Type: FlywheelIterationFilter object

Required: No


The ARN of the flywheel.

Type: String

Length Constraints: Maximum length of 256.

Pattern: arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:flywheel/[a-zA-Z0-9](-*[a-zA-Z0-9])*

Required: Yes


Maximum number of iteration history results to return

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 500.

Required: No


Next token

Type: String

Length Constraints: Minimum length of 1.

Required: No

Response Syntax

{ "FlywheelIterationPropertiesList": [ { "CreationTime": number, "EndTime": number, "EvaluatedModelArn": "string", "EvaluatedModelMetrics": { "AverageAccuracy": number, "AverageF1Score": number, "AveragePrecision": number, "AverageRecall": number }, "EvaluationManifestS3Prefix": "string", "FlywheelArn": "string", "FlywheelIterationId": "string", "Message": "string", "Status": "string", "TrainedModelArn": "string", "TrainedModelMetrics": { "AverageAccuracy": number, "AverageF1Score": number, "AveragePrecision": number, "AverageRecall": number } } ], "NextToken": "string" }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.


List of flywheel iteration properties

Type: Array of FlywheelIterationProperties objects


Next token

Type: String

Length Constraints: Minimum length of 1.


For information about the errors that are common to all actions, see Common Errors.


An internal server error occurred. Retry your request.

HTTP Status Code: 500


The filter specified for the operation is invalid. Specify a different filter.

HTTP Status Code: 400


The request is invalid.

HTTP Status Code: 400


The specified resource ARN was not found. Check the ARN and try your request again.

HTTP Status Code: 400


The number of requests exceeds the limit. Resubmit your request later.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: