Skip to content

CreateFlywheelRequest

Source code in docs_src/capo_comprehend/types/create_flywheel_request.py
class CreateFlywheelRequest(TypedDict, closed=True):
    flywheel_name: "capo_comprehend.types.comprehend_arn_name.ComprehendArnName"
    """<p>Name for the flywheel.</p>"""
    active_model_arn: NotRequired[
        "capo_comprehend.types.comprehend_model_arn.ComprehendModelArn"
    ]
    """<p>To associate an existing model with the flywheel, specify the Amazon Resource Number (ARN) of the model version. Do not set <code>TaskConfig</code> or <code>ModelType</code> if you specify an <code>ActiveModelArn</code>.</p>"""
    data_access_role_arn: "capo_comprehend.types.iam_role_arn.IamRoleArn"
    """<p>The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend the permissions required to access the flywheel data in the data lake.</p>"""
    task_config: NotRequired["capo_comprehend.types.task_config.TaskConfig"]
    """<p>Configuration about the model associated with the flywheel. You need to set <code>TaskConfig</code> if you are creating a flywheel for a new model.</p>"""
    model_type: NotRequired["capo_comprehend.types.model_type.ModelType"]
    """<p>The model type. You need to set <code>ModelType</code> if you are creating a flywheel for a new model.</p>"""
    data_lake_s3_uri: "capo_comprehend.types.flywheel_s3_uri.FlywheelS3Uri"
    """<p>Enter the S3 location for the data lake. You can specify a new S3 bucket or a new folder of an existing S3 bucket. The flywheel creates the data lake at this location.</p>"""
    data_security_config: NotRequired[
        "capo_comprehend.types.data_security_config.DataSecurityConfig"
    ]
    """<p>Data security configurations.</p>"""
    client_request_token: NotRequired[
        "capo_comprehend.types.client_request_token_string.ClientRequestTokenString"
    ]
    """<p>A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.</p>"""
    tags: NotRequired["capo_comprehend.types.tag_list.TagList"]
    """<p>The tags to associate with this flywheel.</p>"""

active_model_arn instance-attribute

active_model_arn: NotRequired[ComprehendModelArn]

To associate an existing model with the flywheel, specify the Amazon Resource Number (ARN) of the model version. Do not set TaskConfig or ModelType if you specify an ActiveModelArn.

client_request_token instance-attribute

client_request_token: NotRequired[ClientRequestTokenString]

A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.

data_access_role_arn instance-attribute

data_access_role_arn: IamRoleArn

The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend the permissions required to access the flywheel data in the data lake.

data_lake_s3_uri instance-attribute

data_lake_s3_uri: FlywheelS3Uri

Enter the S3 location for the data lake. You can specify a new S3 bucket or a new folder of an existing S3 bucket. The flywheel creates the data lake at this location.

data_security_config instance-attribute

data_security_config: NotRequired[DataSecurityConfig]

Data security configurations.

flywheel_name instance-attribute

flywheel_name: ComprehendArnName

Name for the flywheel.

model_type instance-attribute

model_type: NotRequired[ModelType]

The model type. You need to set ModelType if you are creating a flywheel for a new model.

tags instance-attribute

tags: NotRequired[TagList]

The tags to associate with this flywheel.

task_config instance-attribute

task_config: NotRequired[TaskConfig]

Configuration about the model associated with the flywheel. You need to set TaskConfig if you are creating a flywheel for a new model.