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

interface EndpointProperties {
    CreationTime?: Date;
    CurrentInferenceUnits?: number;
    DataAccessRoleArn?: string;
    DesiredDataAccessRoleArn?: string;
    DesiredInferenceUnits?: number;
    DesiredModelArn?: string;
    EndpointArn?: string;
    FlywheelArn?: string;
    LastModifiedTime?: Date;
    Message?: string;
    ModelArn?: string;
    Status?: string;
}

Properties

CreationTime?: Date

The creation date and time of the endpoint.

CurrentInferenceUnits?: number

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

DataAccessRoleArn?: string

The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to trained custom models encrypted with a customer managed key (ModelKmsKeyId).

DesiredDataAccessRoleArn?: string

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

DesiredInferenceUnits?: number

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.</p>
DesiredModelArn?: string

ARN of the new model to use for updating an existing endpoint. This ARN is going to be different from the model ARN when the update is in progress

EndpointArn?: string

The Amazon Resource Number (ARN) of the endpoint.

FlywheelArn?: string

The Amazon Resource Number (ARN) of the flywheel

LastModifiedTime?: Date

The date and time that the endpoint was last modified.

Message?: string

Specifies a reason for failure in cases of Failed status.

ModelArn?: string

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

Status?: string

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.