Amazon Comprehend
Developer Guide

Updating an Endpoint

Frequently, the level of throughput you need changes after creating an endpoint, or your first estimation of your needs changes. When this happens, it may be necessary to update your endpoint to adjust the throughput up or down. Throughput is governed by the number of inference units with which you've provisioned your endpoint. Each inference unit represents a throughput of 100 characters per second for up to 2 documents per second.

It can also be helpful to add tags to your endpoint to help keep them organized. This can also be done while updating your endpoint. For more information on endpoints, see Tagging Custom Classifiers

To update an endpoint (console)

  1. Sign in to the AWS Management Console and open the Amazon Comprehend console.

  2. From the left menu, choose Customization and then choose Custom classification.

  3. From the Classifiers list, choose the name of the custom model for which you want to update the endpoint and follow the link. The custom model details page is displayed.

  4. Navigate to the Endpoints list, choose the name of the endpoint you want to update and follow the link.

  5. To edit the endpoint's tags, choose Manage tags

  6. (Optional) To add a tag to the endpoint, enter a key-value pair under Tags and choose Add tag. To remove this pair before creating the endpoint, choose Remove tag. After editing the tags, choose Save

  7. To edit the number of inference units with which the endpoint is provisioned, choose Edit.

  8. Enter the updated number of inference units to assign to the endpoint. Each unit represents a throughput of 100 characters per second. You can assign up to a maximum of 10 inference units per endpoint.

    Note

    The cost of using an endpoint is based on the amount of time operating and the throughput (based on the number of inference units. Increasing the number of inference units will thus increase the cost of operation. For more information, see Amazon Comprehend Pricing.

  9. Choose Edit endpoint. The endpoint details page is displayed.

  10. Confirm that the endpoint is updating by choosing the model name from the breadcrumbs at the top of the page. On the custom model details page, navigate to the Endpoints list and verify that it shows Updating next to the endpoint. When the update is complete, it will show Ready.

The following example demonstrates using the UpdateEndpoint operation with the AWS CLI.

The example is formatted for Unix, Linux, and macOS. For Windows, replace the backslash (\) Unix continuation character at the end of each line with a caret (^).

aws comprehend update-endpoint \ --desired-inference-units updated number of inference units \ --endpoint-arn arn:aws:comprehend:region:account-id:endpoint/endpoint name

If the action is successful, responds with an HTTP 200 response with an empty HTTP body.