FlywheelProperties - Amazon Comprehend API Reference

FlywheelProperties

The flywheel properties.

Contents

ActiveModelArn

The Amazon Resource Number (ARN) of the active model version.

Type: String

Length Constraints: Maximum length of 256.

Pattern: 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])*)?

Required: No

CreationTime

Creation time of the flywheel.

Type: Timestamp

Required: No

DataAccessRoleArn

The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend permission to access the flywheel data.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+

Required: No

DataLakeS3Uri

Amazon S3 URI of the data lake location.

Type: String

Length Constraints: Maximum length of 1024.

Pattern: s3://[a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9](/.*)?

Required: No

DataSecurityConfig

Data security configuration.

Type: DataSecurityConfig object

Required: No

FlywheelArn

The Amazon Resource Number (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: No

LastModifiedTime

Last modified time for the flywheel.

Type: Timestamp

Required: No

LatestFlywheelIteration

The most recent flywheel iteration.

Type: String

Length Constraints: Maximum length of 63.

Pattern: [0-9]{8}T[0-9]{6}Z

Required: No

Message

A description of the status of the flywheel.

Type: String

Required: No

ModelType

Model type of the flywheel's model.

Type: String

Valid Values: DOCUMENT_CLASSIFIER | ENTITY_RECOGNIZER

Required: No

Status

The status of the flywheel.

Type: String

Valid Values: CREATING | ACTIVE | UPDATING | DELETING | FAILED

Required: No

TaskConfig

Configuration about the model associated with a flywheel.

Type: TaskConfig object

Required: No

See Also

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