Describe Flywheel Iteration

comprehend_describe_flywheel_iteration

R Documentation

Retrieve the configuration properties of a flywheel iteration

Description

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

Usage

comprehend_describe_flywheel_iteration(FlywheelArn, FlywheelIterationId)

Arguments

FlywheelArn

[required]

FlywheelIterationId

[required]

Value

A list with the following syntax:

list(
  FlywheelIterationProperties = list(
    FlywheelArn = "string",
    FlywheelIterationId = "string",
    CreationTime = as.POSIXct(
      "2015-01-01"
    ),
    EndTime = as.POSIXct(
      "2015-01-01"
    ),
    Status = "TRAINING"|"EVALUATING"|"COMPLETED"|"FAILED"|"STOP_REQUESTED"|"STOPPED",
    Message = "string",
    EvaluatedModelArn = "string",
    EvaluatedModelMetrics = list(
      AverageF1Score = 123.0,
      AveragePrecision = 123.0,
      AverageRecall = 123.0,
      AverageAccuracy = 123.0
    ),
    TrainedModelArn = "string",
    TrainedModelMetrics = list(
      AverageF1Score = 123.0,
      AveragePrecision = 123.0,
      AverageRecall = 123.0,
      AverageAccuracy = 123.0
    ),
    EvaluationManifestS3Prefix = "string"
  )
)

Request syntax

svc$describe_flywheel_iteration(
  FlywheelArn = "string",
  FlywheelIterationId = "string"
)