Skip to content

FlywheelProperties

Source code in docs_src/capo_comprehend/types/flywheel_properties.py
class FlywheelProperties(TypedDict, closed=True):
    flywheel_arn: NotRequired[
        "capo_comprehend.types.comprehend_flywheel_arn.ComprehendFlywheelArn"
    ]
    """<p>The Amazon Resource Number (ARN) of the flywheel.</p>"""
    active_model_arn: NotRequired[
        "capo_comprehend.types.comprehend_model_arn.ComprehendModelArn"
    ]
    """<p>The Amazon Resource Number (ARN) of the active model version.</p>"""
    data_access_role_arn: NotRequired["capo_comprehend.types.iam_role_arn.IamRoleArn"]
    """<p>The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend permission to access the flywheel data.</p>"""
    task_config: NotRequired["capo_comprehend.types.task_config.TaskConfig"]
    """<p>Configuration about the model associated with a flywheel.</p>"""
    data_lake_s3_uri: NotRequired["capo_comprehend.types.s3_uri.S3Uri"]
    """<p>Amazon S3 URI of the data lake location. </p>"""
    data_security_config: NotRequired[
        "capo_comprehend.types.data_security_config.DataSecurityConfig"
    ]
    """<p>Data security configuration.</p>"""
    status: NotRequired["capo_comprehend.types.flywheel_status.FlywheelStatus"]
    """<p>The status of the flywheel.</p>"""
    model_type: NotRequired["capo_comprehend.types.model_type.ModelType"]
    """<p>Model type of the flywheel's model.</p>"""
    message: NotRequired["capo_comprehend.types.any_length_string.AnyLengthString"]
    """<p>A description of the status of the flywheel.</p>"""
    creation_time: NotRequired["capo_comprehend.types.timestamp.Timestamp"]
    """<p>Creation time of the flywheel.</p>"""
    last_modified_time: NotRequired["capo_comprehend.types.timestamp.Timestamp"]
    """<p>Last modified time for the flywheel.</p>"""
    latest_flywheel_iteration: NotRequired[
        "capo_comprehend.types.flywheel_iteration_id.FlywheelIterationId"
    ]
    """<p>The most recent flywheel iteration.</p>"""

active_model_arn instance-attribute

active_model_arn: NotRequired[ComprehendModelArn]

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

creation_time instance-attribute

creation_time: NotRequired[Timestamp]

Creation time of the flywheel.

data_access_role_arn instance-attribute

data_access_role_arn: NotRequired[IamRoleArn]

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

data_lake_s3_uri instance-attribute

data_lake_s3_uri: NotRequired[S3Uri]

Amazon S3 URI of the data lake location.

data_security_config instance-attribute

data_security_config: NotRequired[DataSecurityConfig]

Data security configuration.

flywheel_arn instance-attribute

flywheel_arn: NotRequired[ComprehendFlywheelArn]

The Amazon Resource Number (ARN) of the flywheel.

last_modified_time instance-attribute

last_modified_time: NotRequired[Timestamp]

Last modified time for the flywheel.

latest_flywheel_iteration instance-attribute

latest_flywheel_iteration: NotRequired[FlywheelIterationId]

The most recent flywheel iteration.

message instance-attribute

message: NotRequired[AnyLengthString]

A description of the status of the flywheel.

model_type instance-attribute

model_type: NotRequired[ModelType]

Model type of the flywheel's model.

status instance-attribute

status: NotRequired[FlywheelStatus]

The status of the flywheel.

task_config instance-attribute

task_config: NotRequired[TaskConfig]

Configuration about the model associated with a flywheel.