flywheel_iterations
Creates, updates, deletes, gets or lists a flywheel_iterations resource.
Overview
| Name | flywheel_iterations |
| Type | Resource |
| Id | aws.comprehend.flywheel_iterations |
Fields
The following fields are returned by SELECT queries:
- describe_flywheel_iteration
| Name | Datatype | Description |
|---|---|---|
creation_time | string (date-time) | The creation start time of the flywheel iteration. |
end_time | string (date-time) | The completion time of this flywheel iteration. |
evaluated_model_arn | string | The ARN of the evaluated model associated with this flywheel iteration. (pattern: <code>arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]:[0-9]{12}:(document-classifier|entity-recognizer)/[a-zA-Z0-9](-[a-zA-Z0-9])(/version/[a-zA-Z0-9](-[a-zA-Z0-9])*)?</code>) |
evaluated_model_metrics | object | The evaluation metrics associated with the evaluated model. |
evaluation_manifest_s3_prefix | string | (pattern: <code>s3://[a-z0-9][.-a-z0-9]{1,61}[a-z0-9](/.*)?</code>) |
flywheel_arn | string | (pattern: <code>arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]:[0-9]{12}:flywheel/[a-zA-Z0-9](-[a-zA-Z0-9])*</code>) |
flywheel_iteration_id | string | (pattern: <code>[0-9]{8}T[0-9]{6}Z</code>) |
message | string | A description of the status of the flywheel iteration. |
status | string | The status of the flywheel iteration. (TRAINING, EVALUATING, COMPLETED, FAILED, STOP_REQUESTED, STOPPED) |
trained_model_arn | string | The ARN of the trained model associated with this flywheel iteration. (pattern: <code>arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]:[0-9]{12}:(document-classifier|entity-recognizer)/[a-zA-Z0-9](-[a-zA-Z0-9])(/version/[a-zA-Z0-9](-[a-zA-Z0-9])*)?</code>) |
trained_model_metrics | object | The evaluation metrics associated with the evaluated model. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
describe_flywheel_iteration | select | region | Retrieve the configuration properties of a flywheel iteration. For more information about flywheels, see Flywheel overview in the Amazon Comprehend Developer Guide. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
region | string | AWS region (default: us-east-1) |
SELECT examples
- describe_flywheel_iteration
Retrieve the configuration properties of a flywheel iteration. For more information about flywheels, see Flywheel overview in the Amazon Comprehend Developer Guide.
SELECT
creation_time,
end_time,
evaluated_model_arn,
evaluated_model_metrics,
evaluation_manifest_s3_prefix,
flywheel_arn,
flywheel_iteration_id,
message,
status,
trained_model_arn,
trained_model_metrics
FROM aws.comprehend.flywheel_iterations
WHERE region = '{{ region }}' -- required
;