Documentation

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

See: newEndpointProperties smart constructor.

Create a value of EndpointProperties with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:creationTime:EndpointProperties', endpointProperties_creationTime - The creation date and time of the endpoint.

$sel:currentInferenceUnits:EndpointProperties', endpointProperties_currentInferenceUnits - The number of inference units currently used by the model using this endpoint.

$sel:dataAccessRoleArn:EndpointProperties', endpointProperties_dataAccessRoleArn - The Amazon Resource Name (ARN) of the AWS identity and Access Management (IAM) role that grants Amazon Comprehend read access to trained custom models encrypted with a customer managed key (ModelKmsKeyId).

$sel:desiredDataAccessRoleArn:EndpointProperties', endpointProperties_desiredDataAccessRoleArn - Data access role ARN to use in case the new model is encrypted with a customer KMS key.

$sel:desiredInferenceUnits:EndpointProperties', endpointProperties_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.

$sel:desiredModelArn:EndpointProperties', endpointProperties_desiredModelArn - 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

$sel:endpointArn:EndpointProperties', endpointProperties_endpointArn - The Amazon Resource Number (ARN) of the endpoint.

$sel:lastModifiedTime:EndpointProperties', endpointProperties_lastModifiedTime - The date and time that the endpoint was last modified.

$sel:message:EndpointProperties', endpointProperties_message - Specifies a reason for failure in cases of Failed status.

$sel:modelArn:EndpointProperties', endpointProperties_modelArn - The Amazon Resource Number (ARN) of the model to which the endpoint is attached.

$sel:status:EndpointProperties', endpointProperties_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.

The creation date and time of the endpoint.

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

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

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

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.

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

The Amazon Resource Number (ARN) of the endpoint.

The date and time that the endpoint was last modified.

Specifies a reason for failure in cases of Failed status.

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

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.