/* * 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 DescribeModelPackage operation. /// public partial class DescribeModelPackageResponse : AmazonWebServiceResponse { private List _additionalInferenceSpecifications = new List(); private string _approvalDescription; private bool? _certifyForMarketplace; private UserContext _createdBy; private DateTime? _creationTime; private Dictionary _customerMetadataProperties = new Dictionary(); private string _domain; private DriftCheckBaselines _driftCheckBaselines; private InferenceSpecification _inferenceSpecification; private UserContext _lastModifiedBy; private DateTime? _lastModifiedTime; private MetadataProperties _metadataProperties; private ModelApprovalStatus _modelApprovalStatus; private ModelMetrics _modelMetrics; private string _modelPackageArn; private string _modelPackageDescription; private string _modelPackageGroupName; private string _modelPackageName; private ModelPackageStatus _modelPackageStatus; private ModelPackageStatusDetails _modelPackageStatusDetails; private int? _modelPackageVersion; private string _samplePayloadUrl; private SourceAlgorithmSpecification _sourceAlgorithmSpecification; private string _task; private ModelPackageValidationSpecification _validationSpecification; /// /// Gets and sets the property AdditionalInferenceSpecifications. /// /// An array of additional Inference Specification objects. Each additional Inference /// Specification specifies artifacts based on this model package that can be used on /// inference endpoints. Generally used with SageMaker Neo to store the compiled artifacts. /// /// [AWSProperty(Min=1, Max=15)] public List AdditionalInferenceSpecifications { get { return this._additionalInferenceSpecifications; } set { this._additionalInferenceSpecifications = value; } } // Check to see if AdditionalInferenceSpecifications property is set internal bool IsSetAdditionalInferenceSpecifications() { return this._additionalInferenceSpecifications != null && this._additionalInferenceSpecifications.Count > 0; } /// /// Gets and sets the property ApprovalDescription. /// /// A description provided for the model approval. /// /// [AWSProperty(Max=1024)] public string ApprovalDescription { get { return this._approvalDescription; } set { this._approvalDescription = value; } } // Check to see if ApprovalDescription property is set internal bool IsSetApprovalDescription() { return this._approvalDescription != null; } /// /// Gets and sets the property CertifyForMarketplace. /// /// Whether the model package is certified for listing on Amazon Web Services Marketplace. /// /// public bool CertifyForMarketplace { get { return this._certifyForMarketplace.GetValueOrDefault(); } set { this._certifyForMarketplace = value; } } // Check to see if CertifyForMarketplace property is set internal bool IsSetCertifyForMarketplace() { return this._certifyForMarketplace.HasValue; } /// /// Gets and sets the property CreatedBy. /// public UserContext CreatedBy { get { return this._createdBy; } set { this._createdBy = value; } } // Check to see if CreatedBy property is set internal bool IsSetCreatedBy() { return this._createdBy != null; } /// /// Gets and sets the property CreationTime. /// /// A timestamp specifying when the model package 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 CustomerMetadataProperties. /// /// The metadata properties associated with the model package versions. /// /// [AWSProperty(Min=1, Max=50)] public Dictionary CustomerMetadataProperties { get { return this._customerMetadataProperties; } set { this._customerMetadataProperties = value; } } // Check to see if CustomerMetadataProperties property is set internal bool IsSetCustomerMetadataProperties() { return this._customerMetadataProperties != null && this._customerMetadataProperties.Count > 0; } /// /// Gets and sets the property Domain. /// /// The machine learning domain of the model package you specified. Common machine learning /// domains include computer vision and natural language processing. /// /// public string Domain { get { return this._domain; } set { this._domain = value; } } // Check to see if Domain property is set internal bool IsSetDomain() { return this._domain != null; } /// /// Gets and sets the property DriftCheckBaselines. /// /// Represents the drift check baselines that can be used when the model monitor is set /// using the model package. For more information, see the topic on Drift /// Detection against Previous Baselines in SageMaker Pipelines in the Amazon SageMaker /// Developer Guide. /// /// public DriftCheckBaselines DriftCheckBaselines { get { return this._driftCheckBaselines; } set { this._driftCheckBaselines = value; } } // Check to see if DriftCheckBaselines property is set internal bool IsSetDriftCheckBaselines() { return this._driftCheckBaselines != null; } /// /// Gets and sets the property InferenceSpecification. /// /// Details about inference jobs that can be run with models based on this model package. /// /// public InferenceSpecification InferenceSpecification { get { return this._inferenceSpecification; } set { this._inferenceSpecification = value; } } // Check to see if InferenceSpecification property is set internal bool IsSetInferenceSpecification() { return this._inferenceSpecification != null; } /// /// Gets and sets the property LastModifiedBy. /// public UserContext LastModifiedBy { get { return this._lastModifiedBy; } set { this._lastModifiedBy = value; } } // Check to see if LastModifiedBy property is set internal bool IsSetLastModifiedBy() { return this._lastModifiedBy != null; } /// /// Gets and sets the property LastModifiedTime. /// /// The last time that the model package was modified. /// /// 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 MetadataProperties. /// public MetadataProperties MetadataProperties { get { return this._metadataProperties; } set { this._metadataProperties = value; } } // Check to see if MetadataProperties property is set internal bool IsSetMetadataProperties() { return this._metadataProperties != null; } /// /// Gets and sets the property ModelApprovalStatus. /// /// The approval status of the model package. /// /// public ModelApprovalStatus ModelApprovalStatus { get { return this._modelApprovalStatus; } set { this._modelApprovalStatus = value; } } // Check to see if ModelApprovalStatus property is set internal bool IsSetModelApprovalStatus() { return this._modelApprovalStatus != null; } /// /// Gets and sets the property ModelMetrics. /// /// Metrics for the model. /// /// public ModelMetrics ModelMetrics { get { return this._modelMetrics; } set { this._modelMetrics = value; } } // Check to see if ModelMetrics property is set internal bool IsSetModelMetrics() { return this._modelMetrics != null; } /// /// Gets and sets the property ModelPackageArn. /// /// The Amazon Resource Name (ARN) of the model package. /// /// [AWSProperty(Required=true, Min=1, Max=2048)] public string ModelPackageArn { get { return this._modelPackageArn; } set { this._modelPackageArn = value; } } // Check to see if ModelPackageArn property is set internal bool IsSetModelPackageArn() { return this._modelPackageArn != null; } /// /// Gets and sets the property ModelPackageDescription. /// /// A brief summary of the model package. /// /// [AWSProperty(Max=1024)] public string ModelPackageDescription { get { return this._modelPackageDescription; } set { this._modelPackageDescription = value; } } // Check to see if ModelPackageDescription property is set internal bool IsSetModelPackageDescription() { return this._modelPackageDescription != null; } /// /// Gets and sets the property ModelPackageGroupName. /// /// If the model is a versioned model, the name of the model group that the versioned /// model belongs to. /// /// [AWSProperty(Min=1, Max=63)] public string ModelPackageGroupName { get { return this._modelPackageGroupName; } set { this._modelPackageGroupName = value; } } // Check to see if ModelPackageGroupName property is set internal bool IsSetModelPackageGroupName() { return this._modelPackageGroupName != null; } /// /// Gets and sets the property ModelPackageName. /// /// The name of the model package being described. /// /// [AWSProperty(Required=true, Min=1, Max=63)] public string ModelPackageName { get { return this._modelPackageName; } set { this._modelPackageName = value; } } // Check to see if ModelPackageName property is set internal bool IsSetModelPackageName() { return this._modelPackageName != null; } /// /// Gets and sets the property ModelPackageStatus. /// /// The current status of the model package. /// /// [AWSProperty(Required=true)] public ModelPackageStatus ModelPackageStatus { get { return this._modelPackageStatus; } set { this._modelPackageStatus = value; } } // Check to see if ModelPackageStatus property is set internal bool IsSetModelPackageStatus() { return this._modelPackageStatus != null; } /// /// Gets and sets the property ModelPackageStatusDetails. /// /// Details about the current status of the model package. /// /// [AWSProperty(Required=true)] public ModelPackageStatusDetails ModelPackageStatusDetails { get { return this._modelPackageStatusDetails; } set { this._modelPackageStatusDetails = value; } } // Check to see if ModelPackageStatusDetails property is set internal bool IsSetModelPackageStatusDetails() { return this._modelPackageStatusDetails != null; } /// /// Gets and sets the property ModelPackageVersion. /// /// The version of the model package. /// /// [AWSProperty(Min=1)] public int ModelPackageVersion { get { return this._modelPackageVersion.GetValueOrDefault(); } set { this._modelPackageVersion = value; } } // Check to see if ModelPackageVersion property is set internal bool IsSetModelPackageVersion() { return this._modelPackageVersion.HasValue; } /// /// Gets and sets the property SamplePayloadUrl. /// /// The Amazon Simple Storage Service (Amazon S3) path where the sample payload are stored. /// This path points to a single gzip compressed tar archive (.tar.gz suffix). /// /// public string SamplePayloadUrl { get { return this._samplePayloadUrl; } set { this._samplePayloadUrl = value; } } // Check to see if SamplePayloadUrl property is set internal bool IsSetSamplePayloadUrl() { return this._samplePayloadUrl != null; } /// /// Gets and sets the property SourceAlgorithmSpecification. /// /// Details about the algorithm that was used to create the model package. /// /// public SourceAlgorithmSpecification SourceAlgorithmSpecification { get { return this._sourceAlgorithmSpecification; } set { this._sourceAlgorithmSpecification = value; } } // Check to see if SourceAlgorithmSpecification property is set internal bool IsSetSourceAlgorithmSpecification() { return this._sourceAlgorithmSpecification != null; } /// /// Gets and sets the property Task. /// /// The machine learning task you specified that your model package accomplishes. Common /// machine learning tasks include object detection and image classification. /// /// public string Task { get { return this._task; } set { this._task = value; } } // Check to see if Task property is set internal bool IsSetTask() { return this._task != null; } /// /// Gets and sets the property ValidationSpecification. /// /// Configurations for one or more transform jobs that SageMaker runs to test the model /// package. /// /// public ModelPackageValidationSpecification ValidationSpecification { get { return this._validationSpecification; } set { this._validationSpecification = value; } } // Check to see if ValidationSpecification property is set internal bool IsSetValidationSpecification() { return this._validationSpecification != null; } } }