EndpointSummary
Provides summary information for an endpoint.
Contents
- CreationTime
-
A timestamp that shows when 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
- 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.
-
OutOfService
: Endpoint is not available to take incoming requests. -
Creating
: CreateEndpoint is executing. -
Updating
: UpdateEndpoint or UpdateEndpointWeightsAndCapacities is executing. -
SystemUpdating
: Endpoint is undergoing maintenance and cannot be updated or deleted or re-scaled until it has completed. This maintenance operation does not change any customer-specified values such as VPC config, KMS encryption, model, instance type, or instance count. -
RollingBack
: Endpoint fails to scale up or down or change its variant weight and is in the process of rolling back to its previous configuration. Once the rollback completes, endpoint returns to anInService
status. This transitional status only applies to an endpoint that has autoscaling enabled and is undergoing variant weight or capacity changes as part of an UpdateEndpointWeightsAndCapacities call or when the UpdateEndpointWeightsAndCapacities operation is called explicitly. -
InService
: Endpoint is available to process incoming requests. -
Deleting
: DeleteEndpoint is executing. -
Failed
: Endpoint could not be created, updated, or re-scaled. UseDescribeEndpointOutput$FailureReason
for information about the failure. DeleteEndpoint is the only operation that can be performed on a failed endpoint.
To get a list of endpoints with a specified status, use the
StatusEquals
filter with a call to ListEndpoints.Type: String
Valid Values:
OutOfService | Creating | Updating | SystemUpdating | RollingBack | InService | Deleting | Failed | UpdateRollbackFailed
Required: Yes
-
- LastModifiedTime
-
A timestamp that shows when the endpoint was last modified.
Type: Timestamp
Required: Yes
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: