Interface EndpointProperties

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?: EndpointStatus;
}

Properties

CreationTime? CurrentInferenceUnits? DataAccessRoleArn? DesiredDataAccessRoleArn? DesiredInferenceUnits? DesiredModelArn? EndpointArn? FlywheelArn? LastModifiedTime? Message? ModelArn? Status?

Properties

Optional CreationTime

CreationTime?: Date

The creation date and time of the endpoint.

Optional CurrentInferenceUnits

CurrentInferenceUnits?: number

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

Optional DataAccessRoleArn

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).

Optional DesiredDataAccessRoleArn

DesiredDataAccessRoleArn?: string

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

Optional DesiredInferenceUnits

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>

Optional DesiredModelArn

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

Optional EndpointArn

EndpointArn?: string

The Amazon Resource Number (ARN) of the endpoint.

Optional FlywheelArn

FlywheelArn?: string

The Amazon Resource Number (ARN) of the flywheel

Optional LastModifiedTime

LastModifiedTime?: Date

The date and time that the endpoint was last modified.

Optional Message

Message?: string

Specifies a reason for failure in cases of Failed status.

Optional ModelArn

ModelArn?: string

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

Optional Status

Status?: EndpointStatus

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.

Settings

Member Visibility

Theme

On This Page