Endpoint - Amazon SageMaker
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

Endpoint

A hosted endpoint for real-time inference.

Contents

CreationTime

The time that the endpoint was created.

Type: Timestamp

Required: Yes

EndpointArn

The Amazon Resource Name (ARN) of the endpoint.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:endpoint/.*

Required: Yes

EndpointConfigName

The endpoint configuration associated with the endpoint.

Type: String

Length Constraints: Maximum length of 63.

Pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}

Required: Yes

EndpointName

The name of the endpoint.

Type: String

Length Constraints: Maximum length of 63.

Pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}

Required: Yes

EndpointStatus

The status of the endpoint.

Type: String

Valid Values: OutOfService | Creating | Updating | SystemUpdating | RollingBack | InService | Deleting | Failed | UpdateRollbackFailed

Required: Yes

LastModifiedTime

The last time the endpoint was modified.

Type: Timestamp

Required: Yes

DataCaptureConfig

The currently active data capture configuration used by your Endpoint.

Type: DataCaptureConfigSummary object

Required: No

FailureReason

If the endpoint failed, the reason it failed.

Type: String

Length Constraints: Maximum length of 1024.

Required: No

MonitoringSchedules

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

Type: Array of MonitoringSchedule objects

Required: No

ProductionVariants

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

Type: Array of ProductionVariantSummary objects

Array Members: Minimum number of 1 item.

Required: No

ShadowProductionVariants

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.

Type: Array of ProductionVariantSummary objects

Array Members: Minimum number of 1 item.

Required: No

Tags

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

Type: Array of Tag objects

Array Members: Minimum number of 0 items. Maximum number of 50 items.

Required: No

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: