/* * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). * You may not use this file except in compliance with the License. * A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either * express or implied. See the License for the specific language governing * permissions and limitations under the License. */ /* * Do not modify this file. This file is generated from the sagemaker-2017-07-24.normal.json service model. */ using System; using System.Collections.Generic; using System.Xml.Serialization; using System.Text; using System.IO; using System.Net; using Amazon.Runtime; using Amazon.Runtime.Internal; namespace Amazon.SageMaker.Model { /// /// This is the response object from the DescribeEndpoint operation. /// public partial class DescribeEndpointResponse : AmazonWebServiceResponse { private AsyncInferenceConfig _asyncInferenceConfig; private DateTime? _creationTime; private DataCaptureConfigSummary _dataCaptureConfig; private string _endpointArn; private string _endpointConfigName; private string _endpointName; private EndpointStatus _endpointStatus; private ExplainerConfig _explainerConfig; private string _failureReason; private DeploymentConfig _lastDeploymentConfig; private DateTime? _lastModifiedTime; private PendingDeploymentSummary _pendingDeploymentSummary; private List _productionVariants = new List(); private List _shadowProductionVariants = new List(); /// /// Gets and sets the property AsyncInferenceConfig. /// /// Returns the description of an endpoint configuration created using the /// CreateEndpointConfig API. /// /// public AsyncInferenceConfig AsyncInferenceConfig { get { return this._asyncInferenceConfig; } set { this._asyncInferenceConfig = value; } } // Check to see if AsyncInferenceConfig property is set internal bool IsSetAsyncInferenceConfig() { return this._asyncInferenceConfig != null; } /// /// Gets and sets the property CreationTime. /// /// A timestamp that shows when the endpoint was created. /// /// [AWSProperty(Required=true)] public DateTime CreationTime { get { return this._creationTime.GetValueOrDefault(); } set { this._creationTime = value; } } // Check to see if CreationTime property is set internal bool IsSetCreationTime() { return this._creationTime.HasValue; } /// /// Gets and sets the property DataCaptureConfig. /// public DataCaptureConfigSummary DataCaptureConfig { get { return this._dataCaptureConfig; } set { this._dataCaptureConfig = value; } } // Check to see if DataCaptureConfig property is set internal bool IsSetDataCaptureConfig() { return this._dataCaptureConfig != null; } /// /// Gets and sets the property EndpointArn. /// /// The Amazon Resource Name (ARN) of the endpoint. /// /// [AWSProperty(Required=true, Min=20, Max=2048)] public string EndpointArn { get { return this._endpointArn; } set { this._endpointArn = value; } } // Check to see if EndpointArn property is set internal bool IsSetEndpointArn() { return this._endpointArn != null; } /// /// Gets and sets the property EndpointConfigName. /// /// The name of the endpoint configuration associated with this endpoint. /// /// [AWSProperty(Required=true, Max=63)] public string EndpointConfigName { get { return this._endpointConfigName; } set { this._endpointConfigName = value; } } // Check to see if EndpointConfigName property is set internal bool IsSetEndpointConfigName() { return this._endpointConfigName != null; } /// /// Gets and sets the property EndpointName. /// /// Name of the endpoint. /// /// [AWSProperty(Required=true, Max=63)] public string EndpointName { get { return this._endpointName; } set { this._endpointName = value; } } // Check to see if EndpointName property is set internal bool IsSetEndpointName() { return this._endpointName != null; } /// /// 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. /// ///
///
[AWSProperty(Required=true)] public EndpointStatus EndpointStatus { get { return this._endpointStatus; } set { this._endpointStatus = value; } } // Check to see if EndpointStatus property is set internal bool IsSetEndpointStatus() { return this._endpointStatus != null; } /// /// Gets and sets the property ExplainerConfig. /// /// The configuration parameters for an explainer. /// /// public ExplainerConfig ExplainerConfig { get { return this._explainerConfig; } set { this._explainerConfig = value; } } // Check to see if ExplainerConfig property is set internal bool IsSetExplainerConfig() { return this._explainerConfig != null; } /// /// Gets and sets the property FailureReason. /// /// If the status of the endpoint is Failed, the reason why it failed. /// /// [AWSProperty(Max=1024)] public string FailureReason { get { return this._failureReason; } set { this._failureReason = value; } } // Check to see if FailureReason property is set internal bool IsSetFailureReason() { return this._failureReason != null; } /// /// Gets and sets the property LastDeploymentConfig. /// /// The most recent deployment configuration for the endpoint. /// /// public DeploymentConfig LastDeploymentConfig { get { return this._lastDeploymentConfig; } set { this._lastDeploymentConfig = value; } } // Check to see if LastDeploymentConfig property is set internal bool IsSetLastDeploymentConfig() { return this._lastDeploymentConfig != null; } /// /// Gets and sets the property LastModifiedTime. /// /// A timestamp that shows when the endpoint was last modified. /// /// [AWSProperty(Required=true)] public DateTime LastModifiedTime { get { return this._lastModifiedTime.GetValueOrDefault(); } set { this._lastModifiedTime = value; } } // Check to see if LastModifiedTime property is set internal bool IsSetLastModifiedTime() { return this._lastModifiedTime.HasValue; } /// /// 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 PendingDeploymentSummary PendingDeploymentSummary { get { return this._pendingDeploymentSummary; } set { this._pendingDeploymentSummary = value; } } // Check to see if PendingDeploymentSummary property is set internal bool IsSetPendingDeploymentSummary() { return this._pendingDeploymentSummary != null; } /// /// Gets and sets the property ProductionVariants. /// /// An array of ProductionVariantSummary /// objects, one for each model hosted behind this endpoint. /// /// [AWSProperty(Min=1)] public List ProductionVariants { get { return this._productionVariants; } set { this._productionVariants = value; } } // Check to see if ProductionVariants property is set internal bool IsSetProductionVariants() { return this._productionVariants != null && this._productionVariants.Count > 0; } /// /// 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. /// /// [AWSProperty(Min=1)] public List ShadowProductionVariants { get { return this._shadowProductionVariants; } set { this._shadowProductionVariants = value; } } // Check to see if ShadowProductionVariants property is set internal bool IsSetShadowProductionVariants() { return this._shadowProductionVariants != null && this._shadowProductionVariants.Count > 0; } } }