Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

UpdateEndpoint

Updates information about the specified endpoint. For information about endpoints, see Managing endpoints.

Request Syntax


{
   "DesiredDataAccessRoleArn": "string",
   "DesiredInferenceUnits": number,
   "DesiredModelArn": "string",
   "EndpointArn": "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.

DesiredDataAccessRoleArn

Data access role ARN to use in case the new model is encrypted with a customer CMK.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+

Required: No

DesiredInferenceUnits

The desired number of inference units to be used by the model using this endpoint. Each inference unit represents of a throughput of 100 characters per second.

Type: Integer

Valid Range: Minimum value of 1.

Required: No

DesiredModelArn

The ARN of the new model to use when updating an existing endpoint.

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

EndpointArn

The Amazon Resource Number (ARN) of the endpoint being updated.

Type: String

Length Constraints: Maximum length of 256.

Pattern: arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:(document-classifier-endpoint|entity-recognizer-endpoint)/[a-zA-Z0-9](-*[a-zA-Z0-9])*

Required: Yes

FlywheelArn

The Amazon Resource Number (ARN) of the flywheel

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: No

Response Syntax


{
   "DesiredModelArn": "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.

DesiredModelArn

The Amazon Resource Number (ARN) of the new model.

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])*)?

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.

Detail: Provides additional detail about why the request failed.

HTTP Status Code: 400

ResourceInUseException

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

HTTP Status Code: 400

ResourceLimitExceededException

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

HTTP Status Code: 400

ResourceNotFoundException

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

HTTP Status Code: 400

ResourceUnavailableException

The specified resource is not available. Check the resource 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