Skip to content

EndpointProperties

Source code in docs_src/capo_comprehend/types/endpoint_properties.py
class EndpointProperties(TypedDict, closed=True):
    endpoint_arn: NotRequired[
        "capo_comprehend.types.comprehend_endpoint_arn.ComprehendEndpointArn"
    ]
    """<p>The Amazon Resource Number (ARN) of the endpoint.</p>"""
    status: NotRequired["capo_comprehend.types.endpoint_status.EndpointStatus"]
    """<p>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 <code>Ready</code> status before making inference requests.</p>"""
    message: NotRequired["capo_comprehend.types.any_length_string.AnyLengthString"]
    """<p>Specifies a reason for failure in cases of <code>Failed</code> status.</p>"""
    model_arn: NotRequired[
        "capo_comprehend.types.comprehend_model_arn.ComprehendModelArn"
    ]
    """<p>The Amazon Resource Number (ARN) of the model to which the endpoint is attached.</p>"""
    desired_model_arn: NotRequired[
        "capo_comprehend.types.comprehend_model_arn.ComprehendModelArn"
    ]
    """<p>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</p>"""
    desired_inference_units: NotRequired[
        "capo_comprehend.types.inference_units_integer.InferenceUnitsInteger"
    ]
    """<p>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>"""
    current_inference_units: NotRequired[
        "capo_comprehend.types.inference_units_integer.InferenceUnitsInteger"
    ]
    """<p>The number of inference units currently used by the model using this endpoint.</p>"""
    creation_time: NotRequired["capo_comprehend.types.timestamp.Timestamp"]
    """<p>The creation date and time of the endpoint.</p>"""
    last_modified_time: NotRequired["capo_comprehend.types.timestamp.Timestamp"]
    """<p>The date and time that the endpoint was last modified.</p>"""
    data_access_role_arn: NotRequired["capo_comprehend.types.iam_role_arn.IamRoleArn"]
    """<p>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).</p>"""
    desired_data_access_role_arn: NotRequired[
        "capo_comprehend.types.iam_role_arn.IamRoleArn"
    ]
    """<p>Data access role ARN to use in case the new model is encrypted with a customer KMS key.</p>"""
    flywheel_arn: NotRequired[
        "capo_comprehend.types.comprehend_flywheel_arn.ComprehendFlywheelArn"
    ]
    """<p>The Amazon Resource Number (ARN) of the flywheel</p>"""

creation_time instance-attribute

creation_time: NotRequired[Timestamp]

The creation date and time of the endpoint.

current_inference_units instance-attribute

current_inference_units: NotRequired[InferenceUnitsInteger]

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

data_access_role_arn instance-attribute

data_access_role_arn: NotRequired[IamRoleArn]

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

desired_data_access_role_arn instance-attribute

desired_data_access_role_arn: NotRequired[IamRoleArn]

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

desired_inference_units instance-attribute

desired_inference_units: NotRequired[InferenceUnitsInteger]

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.

desired_model_arn instance-attribute

desired_model_arn: NotRequired[ComprehendModelArn]

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

endpoint_arn instance-attribute

endpoint_arn: NotRequired[ComprehendEndpointArn]

The Amazon Resource Number (ARN) of the endpoint.

flywheel_arn instance-attribute

flywheel_arn: NotRequired[ComprehendFlywheelArn]

The Amazon Resource Number (ARN) of the flywheel

last_modified_time instance-attribute

last_modified_time: NotRequired[Timestamp]

The date and time that the endpoint was last modified.

message instance-attribute

message: NotRequired[AnyLengthString]

Specifies a reason for failure in cases of Failed status.

model_arn instance-attribute

model_arn: NotRequired[ComprehendModelArn]

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

status instance-attribute

status: NotRequired[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.