UpdateFlywheelCommand

Suggest an Edit

Update the configuration information for an existing flywheel.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { ComprehendClient, UpdateFlywheelCommand } from "@aws-sdk/client-comprehend"; // ES Modules import
// const { ComprehendClient, UpdateFlywheelCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import
const client = new ComprehendClient(config);
const input = { // UpdateFlywheelRequest
  FlywheelArn: "STRING_VALUE", // required
  ActiveModelArn: "STRING_VALUE",
  DataAccessRoleArn: "STRING_VALUE",
  DataSecurityConfig: { // UpdateDataSecurityConfig
    ModelKmsKeyId: "STRING_VALUE",
    VolumeKmsKeyId: "STRING_VALUE",
    VpcConfig: { // VpcConfig
      SecurityGroupIds: [ // SecurityGroupIds // required
        "STRING_VALUE",
      ],
      Subnets: [ // Subnets // required
        "STRING_VALUE",
      ],
    },
  },
};
const command = new UpdateFlywheelCommand(input);
const response = await client.send(command);
// { // UpdateFlywheelResponse
//   FlywheelProperties: { // FlywheelProperties
//     FlywheelArn: "STRING_VALUE",
//     ActiveModelArn: "STRING_VALUE",
//     DataAccessRoleArn: "STRING_VALUE",
//     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
//           },
//         ],
//       },
//     },
//     DataLakeS3Uri: "STRING_VALUE",
//     DataSecurityConfig: { // DataSecurityConfig
//       ModelKmsKeyId: "STRING_VALUE",
//       VolumeKmsKeyId: "STRING_VALUE",
//       DataLakeKmsKeyId: "STRING_VALUE",
//       VpcConfig: { // VpcConfig
//         SecurityGroupIds: [ // SecurityGroupIds // required
//           "STRING_VALUE",
//         ],
//         Subnets: [ // Subnets // required
//           "STRING_VALUE",
//         ],
//       },
//     },
//     Status: "CREATING" || "ACTIVE" || "UPDATING" || "DELETING" || "FAILED",
//     ModelType: "DOCUMENT_CLASSIFIER" || "ENTITY_RECOGNIZER",
//     Message: "STRING_VALUE",
//     CreationTime: new Date("TIMESTAMP"),
//     LastModifiedTime: new Date("TIMESTAMP"),
//     LatestFlywheelIteration: "STRING_VALUE",
//   },
// };

UpdateFlywheelCommand Input

See UpdateFlywheelCommandInput for more details

Parameter
Type
Description
FlywheelArn
Required
string | undefined

The Amazon Resource Number (ARN) of the flywheel to update.

ActiveModelArn
string | undefined

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

DataAccessRoleArn
string | undefined

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

DataSecurityConfig
UpdateDataSecurityConfig | undefined

Flywheel data security configuration.

UpdateFlywheelCommand Output

See UpdateFlywheelCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
FlywheelProperties
FlywheelProperties | undefined

The flywheel properties.

Throws

Name
Fault
Details
InternalServerException
server

An internal server error occurred. Retry your request.

InvalidRequestException
client

The request is invalid.

KmsKeyValidationException
client

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

ResourceNotFoundException
client

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

TooManyRequestsException
client

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

ComprehendServiceException
Base exception class for all service exceptions from Comprehend service.