Skip to content
AWS for Query.Farm

aws.comprehend.describe_flywheel

Example SQL Queries

SELECT * FROM
aws.comprehend.describe_flywheel
WHERE
"flywheel_arn" = 'VALUE';

Description

Provides configuration information about the flywheel. For more information about flywheels, see Flywheel overview in the Amazon Comprehend Developer Guide.

Table Definition

Column NameColumn Data Type
flywheel_arn Required Input Column

The Amazon Resource Number (ARN) of the flywheel.

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
flywheel_properties

The flywheel properties.

STRUCT(
    "flywheel_arn" VARCHAR,
    "active_model_arn" VARCHAR,
    "data_access_role_arn" VARCHAR,
    "task_config" STRUCT(
        "language_code" VARCHAR,
        "document_classification_config" STRUCT(
            "mode" VARCHAR,
            "labels" VARCHAR[]
        ),
        "entity_recognition_config" STRUCT(
            "entity_types" STRUCT(
                "type" VARCHAR
            )[]
        )
    ),
    "data_lake_s3_uri" VARCHAR,
    "data_security_config" STRUCT(
        "model_kms_key_id" VARCHAR,
        "volume_kms_key_id" VARCHAR,
        "data_lake_kms_key_id" VARCHAR,
        "vpc_config" STRUCT(
            "security_group_ids" VARCHAR[],
            "subnets" VARCHAR[]
        )
    ),
    "status" VARCHAR,
    "model_type" VARCHAR,
    "message" VARCHAR,
    "creation_time" TIMESTAMP_S,
    "last_modified_time" TIMESTAMP_S,
    "latest_flywheel_iteration" VARCHAR
)
Show child fields
flywheel_properties.active_model_arn

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

flywheel_properties.creation_time

Creation time of the flywheel.

flywheel_properties.data_access_role_arn

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

flywheel_properties.data_lake_s3_uri

Amazon S3 URI of the data lake location.

flywheel_properties.data_security_config

Data security configuration.

Show child fields
flywheel_properties.data_security_config.data_lake_kms_key_id

ID for the KMS key that Amazon Comprehend uses to encrypt the data in the data lake.

flywheel_properties.data_security_config.model_kms_key_id

ID for the KMS key that Amazon Comprehend uses to encrypt trained custom models. The ModelKmsKeyId can be either of the following formats:

  • KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"

  • Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"

flywheel_properties.data_security_config.volume_kms_key_id

ID for the KMS key that Amazon Comprehend uses to encrypt the volume.

flywheel_properties.data_security_config.vpc_config

Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for the job. For more information, see Amazon VPC.

Show child fields
flywheel_properties.data_security_config.vpc_config.security_group_ids[]
flywheel_properties.data_security_config.vpc_config.subnets[]
flywheel_properties.flywheel_arn

The Amazon Resource Number (ARN) of the flywheel.

flywheel_properties.last_modified_time

Last modified time for the flywheel.

flywheel_properties.latest_flywheel_iteration

The most recent flywheel iteration.

flywheel_properties.message

A description of the status of the flywheel.

flywheel_properties.model_type

Model type of the flywheel's model.

flywheel_properties.status

The status of the flywheel.

flywheel_properties.task_config

Configuration about the model associated with a flywheel.

Show child fields
flywheel_properties.task_config.document_classification_config

Configuration required for a document classification model.

Show child fields
flywheel_properties.task_config.document_classification_config.labels[]
flywheel_properties.task_config.document_classification_config.mode

Classification mode indicates whether the documents are MULTI_CLASS or MULTI_LABEL.

flywheel_properties.task_config.entity_recognition_config

Configuration required for an entity recognition model.

Show child fields
flywheel_properties.task_config.entity_recognition_config.entity_types[]
Show child fields
flywheel_properties.task_config.entity_recognition_config.entity_types[].type

An entity type within a labeled training dataset that Amazon Comprehend uses to train a custom entity recognizer.

Entity types must not contain the following invalid characters: \n (line break), \\n (escaped line break, \r (carriage return), \\r (escaped carriage return), \t (tab), \\t (escaped tab), and , (comma).

flywheel_properties.task_config.language_code

Language code for the language that the model supports.