DescribeEndpoint - Amazon Comprehend API Reference


Gets the properties associated with a specific endpoint. Use this operation to get the status of an endpoint. For information about endpoints, see Managing endpoints.

Request Syntax

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


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

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

Response Syntax

{ "EndpointProperties": { "CreationTime": number, "CurrentInferenceUnits": number, "DataAccessRoleArn": "string", "DesiredDataAccessRoleArn": "string", "DesiredInferenceUnits": number, "DesiredModelArn": "string", "EndpointArn": "string", "FlywheelArn": "string", "LastModifiedTime": number, "Message": "string", "ModelArn": "string", "Status": "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.


Describes information associated with the specific endpoint.

Type: EndpointProperties object


For information about the errors that are common to all actions, see Common Errors.


An internal server error occurred. Retry your request.

HTTP Status Code: 500


The request is invalid.

HTTP Status Code: 400


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

HTTP Status Code: 400


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: