/*
* 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
{
///
/// Container for the parameters to the CreateImageVersion operation.
/// Creates a version of the SageMaker image specified by ImageName
. The
/// version represents the Amazon Elastic Container Registry (ECR) container image specified
/// by BaseImage
.
///
public partial class CreateImageVersionRequest : AmazonSageMakerRequest
{
private List _aliases = new List();
private string _baseImage;
private string _clientToken;
private bool? _horovod;
private string _imageName;
private JobType _jobType;
private string _mlFramework;
private Processor _processor;
private string _programmingLang;
private string _releaseNotes;
private VendorGuidance _vendorGuidance;
///
/// Gets and sets the property Aliases.
///
/// A list of aliases created with the image version.
///
///
public List Aliases
{
get { return this._aliases; }
set { this._aliases = value; }
}
// Check to see if Aliases property is set
internal bool IsSetAliases()
{
return this._aliases != null && this._aliases.Count > 0;
}
///
/// Gets and sets the property BaseImage.
///
/// The registry path of the container image to use as the starting point for this version.
/// The path is an Amazon Elastic Container Registry (ECR) URI in the following format:
///
///
///
/// <acct-id>.dkr.ecr.<region>.amazonaws.com/<repo-name[:tag] or
/// [@digest]>
///
///
[AWSProperty(Required=true, Min=1, Max=255)]
public string BaseImage
{
get { return this._baseImage; }
set { this._baseImage = value; }
}
// Check to see if BaseImage property is set
internal bool IsSetBaseImage()
{
return this._baseImage != null;
}
///
/// Gets and sets the property ClientToken.
///
/// A unique ID. If not specified, the Amazon Web Services CLI and Amazon Web Services
/// SDKs, such as the SDK for Python (Boto3), add a unique value to the call.
///
///
[AWSProperty(Min=1, Max=36)]
public string ClientToken
{
get { return this._clientToken; }
set { this._clientToken = value; }
}
// Check to see if ClientToken property is set
internal bool IsSetClientToken()
{
return this._clientToken != null;
}
///
/// Gets and sets the property Horovod.
///
/// Indicates Horovod compatibility.
///
///
public bool Horovod
{
get { return this._horovod.GetValueOrDefault(); }
set { this._horovod = value; }
}
// Check to see if Horovod property is set
internal bool IsSetHorovod()
{
return this._horovod.HasValue;
}
///
/// Gets and sets the property ImageName.
///
/// The ImageName
of the Image
to create a version of.
///
///
[AWSProperty(Required=true, Min=1, Max=63)]
public string ImageName
{
get { return this._imageName; }
set { this._imageName = value; }
}
// Check to see if ImageName property is set
internal bool IsSetImageName()
{
return this._imageName != null;
}
///
/// Gets and sets the property JobType.
///
/// Indicates SageMaker job type compatibility.
///
/// -
///
///
TRAINING
: The image version is compatible with SageMaker training jobs.
///
/// -
///
///
INFERENCE
: The image version is compatible with SageMaker inference
/// jobs.
///
/// -
///
///
NOTEBOOK_KERNEL
: The image version is compatible with SageMaker notebook
/// kernels.
///
///
///
public JobType JobType
{
get { return this._jobType; }
set { this._jobType = value; }
}
// Check to see if JobType property is set
internal bool IsSetJobType()
{
return this._jobType != null;
}
///
/// Gets and sets the property MLFramework.
///
/// The machine learning framework vended in the image version.
///
///
[AWSProperty(Min=1, Max=128)]
public string MLFramework
{
get { return this._mlFramework; }
set { this._mlFramework = value; }
}
// Check to see if MLFramework property is set
internal bool IsSetMLFramework()
{
return this._mlFramework != null;
}
///
/// Gets and sets the property Processor.
///
/// Indicates CPU or GPU compatibility.
///
/// -
///
///
CPU
: The image version is compatible with CPU.
///
/// -
///
///
GPU
: The image version is compatible with GPU.
///
///
///
public Processor Processor
{
get { return this._processor; }
set { this._processor = value; }
}
// Check to see if Processor property is set
internal bool IsSetProcessor()
{
return this._processor != null;
}
///
/// Gets and sets the property ProgrammingLang.
///
/// The supported programming language and its version.
///
///
[AWSProperty(Min=1, Max=128)]
public string ProgrammingLang
{
get { return this._programmingLang; }
set { this._programmingLang = value; }
}
// Check to see if ProgrammingLang property is set
internal bool IsSetProgrammingLang()
{
return this._programmingLang != null;
}
///
/// Gets and sets the property ReleaseNotes.
///
/// The maintainer description of the image version.
///
///
[AWSProperty(Min=1, Max=255)]
public string ReleaseNotes
{
get { return this._releaseNotes; }
set { this._releaseNotes = value; }
}
// Check to see if ReleaseNotes property is set
internal bool IsSetReleaseNotes()
{
return this._releaseNotes != null;
}
///
/// Gets and sets the property VendorGuidance.
///
/// The stability of the image version, specified by the maintainer.
///
/// -
///
///
NOT_PROVIDED
: The maintainers did not provide a status for image version
/// stability.
///
/// -
///
///
STABLE
: The image version is stable.
///
/// -
///
///
TO_BE_ARCHIVED
: The image version is set to be archived. Custom image
/// versions that are set to be archived are automatically archived after three months.
///
/// -
///
///
ARCHIVED
: The image version is archived. Archived image versions are
/// not searchable and are no longer actively supported.
///
///
///
public VendorGuidance VendorGuidance
{
get { return this._vendorGuidance; }
set { this._vendorGuidance = value; }
}
// Check to see if VendorGuidance property is set
internal bool IsSetVendorGuidance()
{
return this._vendorGuidance != null;
}
}
}