UpdateFlywheel
Update the configuration information for an existing flywheel.
Request Syntax
{
"ActiveModelArn": "string",
"DataAccessRoleArn": "string",
"DataSecurityConfig": {
"ModelKmsKeyId": "string",
"VolumeKmsKeyId": "string",
"VpcConfig": {
"SecurityGroupIds": [ "string" ],
"Subnets": [ "string" ]
}
},
"FlywheelArn": "string"
}Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- ActiveModelArn
-
The Amazon Resource Number (ARN) of the active model version.
Type: String
Length Constraints: Maximum length of 256.
Pattern:
arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:(document-classifier|entity-recognizer)/[a-zA-Z0-9](-*[a-zA-Z0-9])*(/version/[a-zA-Z0-9](-*[a-zA-Z0-9])*)?Required: No
- DataAccessRoleArn
-
The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend permission to access the flywheel data.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 2048.
Pattern:
arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+Required: No
- DataSecurityConfig
-
Flywheel data security configuration.
Type: UpdateDataSecurityConfig object
Required: No
- FlywheelArn
-
The Amazon Resource Number (ARN) of the flywheel to update.
Type: String
Length Constraints: Maximum length of 256.
Pattern:
arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:flywheel/[a-zA-Z0-9](-*[a-zA-Z0-9])*Required: Yes
Response Syntax
{
"FlywheelProperties": {
"ActiveModelArn": "string",
"CreationTime": number,
"DataAccessRoleArn": "string",
"DataLakeS3Uri": "string",
"DataSecurityConfig": {
"DataLakeKmsKeyId": "string",
"ModelKmsKeyId": "string",
"VolumeKmsKeyId": "string",
"VpcConfig": {
"SecurityGroupIds": [ "string" ],
"Subnets": [ "string" ]
}
},
"FlywheelArn": "string",
"LastModifiedTime": number,
"LatestFlywheelIteration": "string",
"Message": "string",
"ModelType": "string",
"Status": "string",
"TaskConfig": {
"DocumentClassificationConfig": {
"Labels": [ "string" ],
"Mode": "string"
},
"EntityRecognitionConfig": {
"EntityTypes": [
{
"Type": "string"
}
]
},
"LanguageCode": "string"
}
}
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- FlywheelProperties
-
The flywheel properties.
Type: FlywheelProperties object
Errors
For information about the errors that are common to all actions, see Common Errors.
- InternalServerException
-
An internal server error occurred. Retry your request.
HTTP Status Code: 500
- InvalidRequestException
-
The request is invalid.
HTTP Status Code: 400
- KmsKeyValidationException
-
The KMS customer managed key (CMK) entered cannot be validated. Verify the key and re-enter it.
HTTP Status Code: 400
- ResourceNotFoundException
-
The specified resource ARN was not found. Check the ARN and try your request again.
HTTP Status Code: 400
- TooManyRequestsException
-
The number of requests exceeds the limit. Resubmit your request later.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
