UpdateEndpointCommand

Suggest an Edit

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

Example Syntax

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

import { ComprehendClient, UpdateEndpointCommand } from "@aws-sdk/client-comprehend"; // ES Modules import
// const { ComprehendClient, UpdateEndpointCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import
const client = new ComprehendClient(config);
const input = { // UpdateEndpointRequest
  EndpointArn: "STRING_VALUE", // required
  DesiredModelArn: "STRING_VALUE",
  DesiredInferenceUnits: Number("int"),
  DesiredDataAccessRoleArn: "STRING_VALUE",
  FlywheelArn: "STRING_VALUE",
};
const command = new UpdateEndpointCommand(input);
const response = await client.send(command);
// { // UpdateEndpointResponse
//   DesiredModelArn: "STRING_VALUE",
// };

UpdateEndpointCommand Input

See UpdateEndpointCommandInput for more details

Parameter
Type
Description
EndpointArn
Required
string | undefined

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

DesiredDataAccessRoleArn
string | undefined

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

DesiredInferenceUnits
number | undefined

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.

DesiredModelArn
string | undefined

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

FlywheelArn
string | undefined

The Amazon Resource Number (ARN) of the flywheel

UpdateEndpointCommand Output

See UpdateEndpointCommandOutput for details

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

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

Throws

Name
Fault
Details
InternalServerException
server

An internal server error occurred. Retry your request.

InvalidRequestException
client

The request is invalid.

ResourceInUseException
client

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

ResourceLimitExceededException
client

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

ResourceNotFoundException
client

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

ResourceUnavailableException
client

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