import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { CreateFlywheelRequest, CreateFlywheelResponse } from "../models/models_0"; /** * @public */ export type { __MetadataBearer }; /** * @public * * The input for {@link CreateFlywheelCommand}. */ export interface CreateFlywheelCommandInput extends CreateFlywheelRequest { } /** * @public * * The output of {@link CreateFlywheelCommand}. */ export interface CreateFlywheelCommandOutput extends CreateFlywheelResponse, __MetadataBearer { } declare const CreateFlywheelCommand_base: { new (input: CreateFlywheelCommandInput): import("@smithy/core/client").CommandImpl; new (input: CreateFlywheelCommandInput): import("@smithy/core/client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions; }; /** *

A flywheel is an Amazon Web Services resource that orchestrates the ongoing training of a model for custom classification * or custom entity recognition. You can create a flywheel to start with an existing trained model, or * Comprehend can create and train a new model.

*

When you create the flywheel, Comprehend creates a data lake in your account. The data lake holds the training * data and test data for all versions of the model.

*

To use a flywheel with an existing trained model, you specify the active model version. Comprehend copies the model's * training data and test data into the flywheel's data lake.

*

To use the flywheel with a new model, you need to provide a dataset for training data (and optional test data) * when you create the flywheel.

*

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

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { ComprehendClient, CreateFlywheelCommand } from "@aws-sdk/client-comprehend"; // ES Modules import * // const { ComprehendClient, CreateFlywheelCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import * // import type { ComprehendClientConfig } from "@aws-sdk/client-comprehend"; * const config = {}; // type is ComprehendClientConfig * const client = new ComprehendClient(config); * const input = { // CreateFlywheelRequest * FlywheelName: "STRING_VALUE", // required * ActiveModelArn: "STRING_VALUE", * DataAccessRoleArn: "STRING_VALUE", // required * TaskConfig: { // TaskConfig * LanguageCode: "en" || "es" || "fr" || "de" || "it" || "pt" || "ar" || "hi" || "ja" || "ko" || "zh" || "zh-TW", // required * DocumentClassificationConfig: { // DocumentClassificationConfig * Mode: "MULTI_CLASS" || "MULTI_LABEL", // required * Labels: [ // LabelsList * "STRING_VALUE", * ], * }, * EntityRecognitionConfig: { // EntityRecognitionConfig * EntityTypes: [ // EntityTypesList // required * { // EntityTypesListItem * Type: "STRING_VALUE", // required * }, * ], * }, * }, * ModelType: "DOCUMENT_CLASSIFIER" || "ENTITY_RECOGNIZER", * DataLakeS3Uri: "STRING_VALUE", // required * DataSecurityConfig: { // DataSecurityConfig * ModelKmsKeyId: "STRING_VALUE", * VolumeKmsKeyId: "STRING_VALUE", * DataLakeKmsKeyId: "STRING_VALUE", * VpcConfig: { // VpcConfig * SecurityGroupIds: [ // SecurityGroupIds // required * "STRING_VALUE", * ], * Subnets: [ // Subnets // required * "STRING_VALUE", * ], * }, * }, * ClientRequestToken: "STRING_VALUE", * Tags: [ // TagList * { // Tag * Key: "STRING_VALUE", // required * Value: "STRING_VALUE", * }, * ], * }; * const command = new CreateFlywheelCommand(input); * const response = await client.send(command); * // { // CreateFlywheelResponse * // FlywheelArn: "STRING_VALUE", * // ActiveModelArn: "STRING_VALUE", * // }; * * ``` * * @param CreateFlywheelCommandInput - {@link CreateFlywheelCommandInput} * @returns {@link CreateFlywheelCommandOutput} * @see {@link CreateFlywheelCommandInput} for command's `input` shape. * @see {@link CreateFlywheelCommandOutput} for command's `response` shape. * @see {@link ComprehendClientResolvedConfig | config} for ComprehendClient's `config` shape. * * @throws {@link InternalServerException} (server fault) *

An internal server error occurred. Retry your request.

* * @throws {@link InvalidRequestException} (client fault) *

The request is invalid.

* * @throws {@link KmsKeyValidationException} (client fault) *

The KMS customer managed key (CMK) entered cannot be validated. Verify the key and * re-enter it.

* * @throws {@link ResourceInUseException} (client fault) *

The specified resource name is already in use. Use a different name and try your request * again.

* * @throws {@link ResourceLimitExceededException} (client fault) *

The maximum number of resources per account has been exceeded. Review the resources, and * then try your request again.

* * @throws {@link ResourceNotFoundException} (client fault) *

The specified resource ARN was not found. Check the ARN and try your request again.

* * @throws {@link ResourceUnavailableException} (client fault) *

The specified resource is not available. Check the resource and try your request * again.

* * @throws {@link TooManyRequestsException} (client fault) *

The number of requests exceeds the limit. Resubmit your request later.

* * @throws {@link TooManyTagsException} (client fault) *

The request contains more tags than can be associated with a resource (50 tags per * resource). The maximum number of tags includes both existing tags and those included in your * current request.

* * @throws {@link UnsupportedLanguageException} (client fault) *

Amazon Comprehend can't process the language of the input text. For a list of supported languages, * Supported languages in the Comprehend Developer Guide. *

* * @throws {@link ComprehendServiceException} *

Base exception class for all service exceptions from Comprehend service.

* * * @public */ export declare class CreateFlywheelCommand extends CreateFlywheelCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: CreateFlywheelRequest; output: CreateFlywheelResponse; }; sdk: { input: CreateFlywheelCommandInput; output: CreateFlywheelCommandOutput; }; }; }