AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

This is the response object from the DescribeEndpoint operation.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceResponse
    Amazon.SageMaker.Model.DescribeEndpointResponse

Namespace: Amazon.SageMaker.Model
Assembly: AWSSDK.SageMaker.dll
Version: 3.x.y.z

Syntax

C#
public class DescribeEndpointResponse : AmazonWebServiceResponse

The DescribeEndpointResponse type exposes the following members

Constructors

NameDescription
Public Method DescribeEndpointResponse()

Properties

NameTypeDescription
Public Property AsyncInferenceConfig Amazon.SageMaker.Model.AsyncInferenceConfig

Gets and sets the property AsyncInferenceConfig.

Returns the description of an endpoint configuration created using the CreateEndpointConfig API.

Public Property ContentLength System.Int64 Inherited from Amazon.Runtime.AmazonWebServiceResponse.
Public Property CreationTime System.DateTime

Gets and sets the property CreationTime.

A timestamp that shows when the endpoint was created.

Public Property DataCaptureConfig Amazon.SageMaker.Model.DataCaptureConfigSummary

Gets and sets the property DataCaptureConfig.

Public Property EndpointArn System.String

Gets and sets the property EndpointArn.

The Amazon Resource Name (ARN) of the endpoint.

Public Property EndpointConfigName System.String

Gets and sets the property EndpointConfigName.

The name of the endpoint configuration associated with this endpoint.

Public Property EndpointName System.String

Gets and sets the property EndpointName.

Name of the endpoint.

Public Property EndpointStatus Amazon.SageMaker.EndpointStatus

Gets and sets the property 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 an InService 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. Use the FailureReason value returned by DescribeEndpoint for information about the failure. DeleteEndpoint is the only operation that can be performed on a failed endpoint.

  • UpdateRollbackFailed: Both the rolling deployment and auto-rollback failed. Your endpoint is in service with a mix of the old and new endpoint configurations. For information about how to remedy this issue and restore the endpoint's status to InService, see Rolling Deployments.

Public Property ExplainerConfig Amazon.SageMaker.Model.ExplainerConfig

Gets and sets the property ExplainerConfig.

The configuration parameters for an explainer.

Public Property FailureReason System.String

Gets and sets the property FailureReason.

If the status of the endpoint is Failed, the reason why it failed.

Public Property HttpStatusCode System.Net.HttpStatusCode Inherited from Amazon.Runtime.AmazonWebServiceResponse.
Public Property LastDeploymentConfig Amazon.SageMaker.Model.DeploymentConfig

Gets and sets the property LastDeploymentConfig.

The most recent deployment configuration for the endpoint.

Public Property LastModifiedTime System.DateTime

Gets and sets the property LastModifiedTime.

A timestamp that shows when the endpoint was last modified.

Public Property PendingDeploymentSummary Amazon.SageMaker.Model.PendingDeploymentSummary

Gets and sets the property PendingDeploymentSummary.

Returns the summary of an in-progress deployment. This field is only returned when the endpoint is creating or updating with a new endpoint configuration.

Public Property ProductionVariants System.Collections.Generic.List<Amazon.SageMaker.Model.ProductionVariantSummary>

Gets and sets the property ProductionVariants.

An array of ProductionVariantSummary objects, one for each model hosted behind this endpoint.

Public Property ResponseMetadata Amazon.Runtime.ResponseMetadata Inherited from Amazon.Runtime.AmazonWebServiceResponse.
Public Property ShadowProductionVariants System.Collections.Generic.List<Amazon.SageMaker.Model.ProductionVariantSummary>

Gets and sets the property ShadowProductionVariants.

An array of ProductionVariantSummary objects, one for each model that you want to host at this endpoint in shadow mode with production traffic replicated from the model specified on ProductionVariants.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer, 3.5