Amazon Comprehend
Developer Guide

ListEndpoints

Gets a list of all existing endpoints that you've created.

Request Syntax

{ "Filter": { "CreationTimeAfter": number, "CreationTimeBefore": number, "ModelArn": "string", "Status": "string" }, "MaxResults": number, "NextToken": "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.

Filter

Filters the endpoints that are returned. You can filter endpoints on their name, model, status, or the date and time that they were created. You can only set one filter at a time.

Type: EndpointFilter object

Required: No

MaxResults

The maximum number of results to return in each page. The default is 100.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 500.

Required: No

NextToken

Identifies the next page of results to return.

Type: String

Length Constraints: Minimum length of 1.

Required: No

Response Syntax

{ "EndpointPropertiesList": [ { "CreationTime": number, "CurrentInferenceUnits": number, "DesiredInferenceUnits": number, "EndpointArn": "string", "LastModifiedTime": number, "Message": "string", "ModelArn": "string", "Status": "string" } ], "NextToken": "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.

EndpointPropertiesList

Displays a list of endpoint properties being retrieved by the service in response to the request.

Type: Array of EndpointProperties objects

NextToken

Identifies the next page of results to return.

Type: String

Length Constraints: Minimum length of 1.

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

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: