Amazon Comprehend
Developer Guide

EndpointProperties

Specifies information about the specified endpoint.

Contents

CreationTime

The creation date and time of the endpoint.

Type: Timestamp

Required: No

CurrentInferenceUnits

The number of inference units currently used by the model using this endpoint.

Type: Integer

Valid Range: Minimum value of 1.

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

EndpointArn

The Amazon Resource Number (ARN) of the endpoint.

Type: String

Length Constraints: Maximum length of 256.

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

Required: No

LastModifiedTime

The date and time that the endpoint was last modified.

Type: Timestamp

Required: No

Message

Specifies a reason for failure in cases of Failed status.

Type: String

Required: No

ModelArn

The Amazon Resource Number (ARN) of the model to which the endpoint is attached.

Type: String

Length Constraints: Maximum length of 256.

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

Required: No

Status

Specifies the status of the endpoint. Because the endpoint updates and creation are asynchronous, so customers will need to wait for the endpoint to be Ready status before making inference requests.

Type: String

Valid Values: CREATING | DELETING | FAILED | IN_SERVICE | UPDATING

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

On this page: