Skip to content

Endpoint

Source code in docs_src/capo_sagemaker/types/endpoint.py
class Endpoint(TypedDict, closed=True):
    endpoint_name: NotRequired["capo_sagemaker.types.endpoint_name.EndpointName"]
    """<p>The name of the endpoint.</p>"""
    endpoint_arn: NotRequired["capo_sagemaker.types.endpoint_arn.EndpointArn"]
    """<p>The Amazon Resource Name (ARN) of the endpoint.</p>"""
    endpoint_config_name: NotRequired[
        "capo_sagemaker.types.endpoint_config_name.EndpointConfigName"
    ]
    """<p>The endpoint configuration associated with the endpoint.</p>"""
    production_variants: NotRequired[
        "capo_sagemaker.types.production_variant_summary_list.ProductionVariantSummaryList"
    ]
    """<p>A list of the production variants hosted on the endpoint. Each production variant is a model.</p>"""
    data_capture_config: NotRequired[
        "capo_sagemaker.types.data_capture_config_summary.DataCaptureConfigSummary"
    ]
    endpoint_status: NotRequired["capo_sagemaker.types.endpoint_status.EndpointStatus"]
    """<p>The status of the endpoint.</p>"""
    failure_reason: NotRequired["capo_sagemaker.types.failure_reason.FailureReason"]
    """<p>If the endpoint failed, the reason it failed.</p>"""
    creation_time: NotRequired["capo_sagemaker.types.timestamp.Timestamp"]
    """<p>The time that the endpoint was created.</p>"""
    last_modified_time: NotRequired["capo_sagemaker.types.timestamp.Timestamp"]
    """<p>The last time the endpoint was modified.</p>"""
    monitoring_schedules: NotRequired[
        "capo_sagemaker.types.monitoring_schedule_list.MonitoringScheduleList"
    ]
    """<p>A list of monitoring schedules for the endpoint. For information about model monitoring, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/model-monitor.html">Amazon SageMaker Model Monitor</a>.</p>"""
    tags: NotRequired["capo_sagemaker.types.tag_list.TagList"]
    """<p>A list of the tags associated with the endpoint. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services resources</a> in the <i>Amazon Web Services General Reference Guide</i>.</p>"""
    shadow_production_variants: NotRequired[
        "capo_sagemaker.types.production_variant_summary_list.ProductionVariantSummaryList"
    ]
    """<p>A list of the shadow variants hosted on the endpoint. Each shadow variant is a model in shadow mode with production traffic replicated from the production variant.</p>"""

creation_time instance-attribute

creation_time: NotRequired[Timestamp]

The time that the endpoint was created.

data_capture_config instance-attribute

data_capture_config: NotRequired[DataCaptureConfigSummary]

endpoint_arn instance-attribute

endpoint_arn: NotRequired[EndpointArn]

The Amazon Resource Name (ARN) of the endpoint.

endpoint_config_name instance-attribute

endpoint_config_name: NotRequired[EndpointConfigName]

The endpoint configuration associated with the endpoint.

endpoint_name instance-attribute

endpoint_name: NotRequired[EndpointName]

The name of the endpoint.

endpoint_status instance-attribute

endpoint_status: NotRequired[EndpointStatus]

The status of the endpoint.

failure_reason instance-attribute

failure_reason: NotRequired[FailureReason]

If the endpoint failed, the reason it failed.

last_modified_time instance-attribute

last_modified_time: NotRequired[Timestamp]

The last time the endpoint was modified.

monitoring_schedules instance-attribute

monitoring_schedules: NotRequired[MonitoringScheduleList]

A list of monitoring schedules for the endpoint. For information about model monitoring, see Amazon SageMaker Model Monitor.

production_variants instance-attribute

production_variants: NotRequired[ProductionVariantSummaryList]

A list of the production variants hosted on the endpoint. Each production variant is a model.

shadow_production_variants instance-attribute

shadow_production_variants: NotRequired[ProductionVariantSummaryList]

A list of the shadow variants hosted on the endpoint. Each shadow variant is a model in shadow mode with production traffic replicated from the production variant.

tags instance-attribute

tags: NotRequired[TagList]

A list of the tags associated with the endpoint. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference Guide.