Amazon Comprehend · JSON Structure

Openapi.Yml Flywheel Properties Structure

The flywheel properties.

Type: object Properties: 12
Machine LearningNatural Language ProcessingNLPText Analysis

FlywheelProperties is a JSON Structure definition published by Amazon Comprehend, describing 12 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

FlywheelArn ActiveModelArn DataAccessRoleArn TaskConfig DataLakeS3Uri DataSecurityConfig Status ModelType Message CreationTime LastModifiedTime LatestFlywheelIteration

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-comprehend/refs/heads/main/json-structure/openapi.yml-flywheel-properties-structure.json",
  "name": "FlywheelProperties",
  "description": "The flywheel properties.",
  "type": "object",
  "properties": {
    "FlywheelArn": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ComprehendFlywheelArn"
        },
        {
          "description": "The Amazon Resource Number (ARN) of the flywheel."
        }
      ]
    },
    "ActiveModelArn": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ComprehendModelArn"
        },
        {
          "description": "The Amazon Resource Number (ARN) of the active model version."
        }
      ]
    },
    "DataAccessRoleArn": {
      "allOf": [
        {
          "$ref": "#/components/schemas/IamRoleArn"
        },
        {
          "description": "The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend permission to access the flywheel data."
        }
      ]
    },
    "TaskConfig": {
      "allOf": [
        {
          "$ref": "#/components/schemas/TaskConfig"
        },
        {
          "description": "Configuration about the custom classifier associated with the flywheel."
        }
      ]
    },
    "DataLakeS3Uri": {
      "allOf": [
        {
          "$ref": "#/components/schemas/S3Uri"
        },
        {
          "description": "Amazon S3 URI of the data lake location. "
        }
      ]
    },
    "DataSecurityConfig": {
      "allOf": [
        {
          "$ref": "#/components/schemas/DataSecurityConfig"
        },
        {
          "description": "Data security configuration."
        }
      ]
    },
    "Status": {
      "allOf": [
        {
          "$ref": "#/components/schemas/FlywheelStatus"
        },
        {
          "description": "The status of the flywheel."
        }
      ]
    },
    "ModelType": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ModelType"
        },
        {
          "description": "Model type of the flywheel's model."
        }
      ]
    },
    "Message": {
      "allOf": [
        {
          "$ref": "#/components/schemas/AnyLengthString"
        },
        {
          "description": "A description of the status of the flywheel."
        }
      ]
    },
    "CreationTime": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Timestamp"
        },
        {
          "description": "Creation time of the flywheel."
        }
      ]
    },
    "LastModifiedTime": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Timestamp"
        },
        {
          "description": "Last modified time for the flywheel."
        }
      ]
    },
    "LatestFlywheelIteration": {
      "allOf": [
        {
          "$ref": "#/components/schemas/FlywheelIterationId"
        },
        {
          "description": "The most recent flywheel iteration."
        }
      ]
    }
  }
}