Show / Hide Table of Contents

Class CfnModelPackage

A CloudFormation AWS::SageMaker::ModelPackage.

Inheritance
System.Object
Construct
CfnElement
CfnRefElement
CfnResource
CfnModelPackage
Implements
IConstruct
Constructs.IConstruct
IDependable
IInspectable
Inherited Members
CfnResource.IsCfnResource(IConstruct)
CfnResource.AddDeletionOverride(String)
CfnResource.AddDependsOn(CfnResource)
CfnResource.AddMetadata(String, Object)
CfnResource.AddOverride(String, Object)
CfnResource.AddPropertyDeletionOverride(String)
CfnResource.AddPropertyOverride(String, Object)
CfnResource.ApplyRemovalPolicy(Nullable<RemovalPolicy>, IRemovalPolicyOptions)
CfnResource.GetAtt(String)
CfnResource.GetMetadata(String)
CfnResource.ShouldSynthesize()
CfnResource.ToString()
CfnResource.ValidateProperties(Object)
CfnResource.CfnOptions
CfnResource.CfnResourceType
CfnResource.UpdatedProperites
CfnRefElement.Ref
CfnElement.IsCfnElement(Object)
CfnElement.OverrideLogicalId(String)
CfnElement.CreationStack
CfnElement.LogicalId
CfnElement.Stack
Construct.IsConstruct(Object)
Construct.OnPrepare()
Construct.OnSynthesize(ISynthesisSession)
Construct.OnValidate()
Construct.Prepare()
Construct.Synthesize(ISynthesisSession)
Construct.Validate()
Construct.Node
Namespace: Amazon.CDK.AWS.Sagemaker
Assembly: Amazon.CDK.AWS.Sagemaker.dll
Syntax (csharp)
public class CfnModelPackage : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnModelPackage
    Inherits CfnResource
    Implements IConstruct, IDependable, IInspectable
Remarks

A versioned model that can be deployed for SageMaker inference.

CloudformationResource: AWS::SageMaker::ModelPackage

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelpackage.html

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Sagemaker;

var modelInput;

var cfnModelPackage = new CfnModelPackage(this, "MyCfnModelPackage", new CfnModelPackageProps {
    AdditionalInferenceSpecificationDefinition = new AdditionalInferenceSpecificationDefinitionProperty {
        Containers = new [] { new ModelPackageContainerDefinitionProperty {
            Image = "image",

            // the properties below are optional
            ContainerHostname = "containerHostname",
            Environment = new Dictionary<string, string> {
                { "environmentKey", "environment" }
            },
            Framework = "framework",
            FrameworkVersion = "frameworkVersion",
            ImageDigest = "imageDigest",
            ModelDataUrl = "modelDataUrl",
            ModelInput = modelInput,
            NearestModelName = "nearestModelName",
            ProductId = "productId"
        } },
        Name = "name",

        // the properties below are optional
        Description = "description",
        SupportedContentTypes = new [] { "supportedContentTypes" },
        SupportedRealtimeInferenceInstanceTypes = new [] { "supportedRealtimeInferenceInstanceTypes" },
        SupportedResponseMimeTypes = new [] { "supportedResponseMimeTypes" },
        SupportedTransformInstanceTypes = new [] { "supportedTransformInstanceTypes" }
    },
    AdditionalInferenceSpecifications = new [] { new AdditionalInferenceSpecificationDefinitionProperty {
        Containers = new [] { new ModelPackageContainerDefinitionProperty {
            Image = "image",

            // the properties below are optional
            ContainerHostname = "containerHostname",
            Environment = new Dictionary<string, string> {
                { "environmentKey", "environment" }
            },
            Framework = "framework",
            FrameworkVersion = "frameworkVersion",
            ImageDigest = "imageDigest",
            ModelDataUrl = "modelDataUrl",
            ModelInput = modelInput,
            NearestModelName = "nearestModelName",
            ProductId = "productId"
        } },
        Name = "name",

        // the properties below are optional
        Description = "description",
        SupportedContentTypes = new [] { "supportedContentTypes" },
        SupportedRealtimeInferenceInstanceTypes = new [] { "supportedRealtimeInferenceInstanceTypes" },
        SupportedResponseMimeTypes = new [] { "supportedResponseMimeTypes" },
        SupportedTransformInstanceTypes = new [] { "supportedTransformInstanceTypes" }
    } },
    AdditionalInferenceSpecificationsToAdd = new [] { new AdditionalInferenceSpecificationDefinitionProperty {
        Containers = new [] { new ModelPackageContainerDefinitionProperty {
            Image = "image",

            // the properties below are optional
            ContainerHostname = "containerHostname",
            Environment = new Dictionary<string, string> {
                { "environmentKey", "environment" }
            },
            Framework = "framework",
            FrameworkVersion = "frameworkVersion",
            ImageDigest = "imageDigest",
            ModelDataUrl = "modelDataUrl",
            ModelInput = modelInput,
            NearestModelName = "nearestModelName",
            ProductId = "productId"
        } },
        Name = "name",

        // the properties below are optional
        Description = "description",
        SupportedContentTypes = new [] { "supportedContentTypes" },
        SupportedRealtimeInferenceInstanceTypes = new [] { "supportedRealtimeInferenceInstanceTypes" },
        SupportedResponseMimeTypes = new [] { "supportedResponseMimeTypes" },
        SupportedTransformInstanceTypes = new [] { "supportedTransformInstanceTypes" }
    } },
    ApprovalDescription = "approvalDescription",
    CertifyForMarketplace = false,
    ClientToken = "clientToken",
    CreatedBy = new UserContextProperty {
        DomainId = "domainId",
        UserProfileArn = "userProfileArn",
        UserProfileName = "userProfileName"
    },
    CustomerMetadataProperties = new Dictionary<string, string> {
        { "customerMetadataPropertiesKey", "customerMetadataProperties" }
    },
    Domain = "domain",
    DriftCheckBaselines = new DriftCheckBaselinesProperty {
        Bias = new DriftCheckBiasProperty {
            ConfigFile = new FileSourceProperty {
                S3Uri = "s3Uri",

                // the properties below are optional
                ContentDigest = "contentDigest",
                ContentType = "contentType"
            },
            PostTrainingConstraints = new MetricsSourceProperty {
                ContentType = "contentType",
                S3Uri = "s3Uri",

                // the properties below are optional
                ContentDigest = "contentDigest"
            },
            PreTrainingConstraints = new MetricsSourceProperty {
                ContentType = "contentType",
                S3Uri = "s3Uri",

                // the properties below are optional
                ContentDigest = "contentDigest"
            }
        },
        Explainability = new DriftCheckExplainabilityProperty {
            ConfigFile = new FileSourceProperty {
                S3Uri = "s3Uri",

                // the properties below are optional
                ContentDigest = "contentDigest",
                ContentType = "contentType"
            },
            Constraints = new MetricsSourceProperty {
                ContentType = "contentType",
                S3Uri = "s3Uri",

                // the properties below are optional
                ContentDigest = "contentDigest"
            }
        },
        ModelDataQuality = new DriftCheckModelDataQualityProperty {
            Constraints = new MetricsSourceProperty {
                ContentType = "contentType",
                S3Uri = "s3Uri",

                // the properties below are optional
                ContentDigest = "contentDigest"
            },
            Statistics = new MetricsSourceProperty {
                ContentType = "contentType",
                S3Uri = "s3Uri",

                // the properties below are optional
                ContentDigest = "contentDigest"
            }
        },
        ModelQuality = new DriftCheckModelQualityProperty {
            Constraints = new MetricsSourceProperty {
                ContentType = "contentType",
                S3Uri = "s3Uri",

                // the properties below are optional
                ContentDigest = "contentDigest"
            },
            Statistics = new MetricsSourceProperty {
                ContentType = "contentType",
                S3Uri = "s3Uri",

                // the properties below are optional
                ContentDigest = "contentDigest"
            }
        }
    },
    Environment = new Dictionary<string, string> {
        { "environmentKey", "environment" }
    },
    InferenceSpecification = new InferenceSpecificationProperty {
        Containers = new [] { new ModelPackageContainerDefinitionProperty {
            Image = "image",

            // the properties below are optional
            ContainerHostname = "containerHostname",
            Environment = new Dictionary<string, string> {
                { "environmentKey", "environment" }
            },
            Framework = "framework",
            FrameworkVersion = "frameworkVersion",
            ImageDigest = "imageDigest",
            ModelDataUrl = "modelDataUrl",
            ModelInput = modelInput,
            NearestModelName = "nearestModelName",
            ProductId = "productId"
        } },
        SupportedContentTypes = new [] { "supportedContentTypes" },
        SupportedResponseMimeTypes = new [] { "supportedResponseMimeTypes" },

        // the properties below are optional
        SupportedRealtimeInferenceInstanceTypes = new [] { "supportedRealtimeInferenceInstanceTypes" },
        SupportedTransformInstanceTypes = new [] { "supportedTransformInstanceTypes" }
    },
    LastModifiedBy = new UserContextProperty {
        DomainId = "domainId",
        UserProfileArn = "userProfileArn",
        UserProfileName = "userProfileName"
    },
    LastModifiedTime = "lastModifiedTime",
    MetadataProperties = new MetadataPropertiesProperty {
        CommitId = "commitId",
        GeneratedBy = "generatedBy",
        ProjectId = "projectId",
        Repository = "repository"
    },
    ModelApprovalStatus = "modelApprovalStatus",
    ModelMetrics = new ModelMetricsProperty {
        Bias = new BiasProperty {
            PostTrainingReport = new MetricsSourceProperty {
                ContentType = "contentType",
                S3Uri = "s3Uri",

                // the properties below are optional
                ContentDigest = "contentDigest"
            },
            PreTrainingReport = new MetricsSourceProperty {
                ContentType = "contentType",
                S3Uri = "s3Uri",

                // the properties below are optional
                ContentDigest = "contentDigest"
            },
            Report = new MetricsSourceProperty {
                ContentType = "contentType",
                S3Uri = "s3Uri",

                // the properties below are optional
                ContentDigest = "contentDigest"
            }
        },
        Explainability = new ExplainabilityProperty {
            Report = new MetricsSourceProperty {
                ContentType = "contentType",
                S3Uri = "s3Uri",

                // the properties below are optional
                ContentDigest = "contentDigest"
            }
        },
        ModelDataQuality = new ModelDataQualityProperty {
            Constraints = new MetricsSourceProperty {
                ContentType = "contentType",
                S3Uri = "s3Uri",

                // the properties below are optional
                ContentDigest = "contentDigest"
            },
            Statistics = new MetricsSourceProperty {
                ContentType = "contentType",
                S3Uri = "s3Uri",

                // the properties below are optional
                ContentDigest = "contentDigest"
            }
        },
        ModelQuality = new ModelQualityProperty {
            Constraints = new MetricsSourceProperty {
                ContentType = "contentType",
                S3Uri = "s3Uri",

                // the properties below are optional
                ContentDigest = "contentDigest"
            },
            Statistics = new MetricsSourceProperty {
                ContentType = "contentType",
                S3Uri = "s3Uri",

                // the properties below are optional
                ContentDigest = "contentDigest"
            }
        }
    },
    ModelPackageDescription = "modelPackageDescription",
    ModelPackageGroupName = "modelPackageGroupName",
    ModelPackageName = "modelPackageName",
    ModelPackageStatusDetails = new ModelPackageStatusDetailsProperty {
        ValidationStatuses = new [] { new ModelPackageStatusItemProperty {
            Name = "name",
            Status = "status",

            // the properties below are optional
            FailureReason = "failureReason"
        } },

        // the properties below are optional
        ImageScanStatuses = new [] { new ModelPackageStatusItemProperty {
            Name = "name",
            Status = "status",

            // the properties below are optional
            FailureReason = "failureReason"
        } }
    },
    ModelPackageStatusItem = new ModelPackageStatusItemProperty {
        Name = "name",
        Status = "status",

        // the properties below are optional
        FailureReason = "failureReason"
    },
    ModelPackageVersion = 123,
    SamplePayloadUrl = "samplePayloadUrl",
    SourceAlgorithmSpecification = new SourceAlgorithmSpecificationProperty {
        SourceAlgorithms = new [] { new SourceAlgorithmProperty {
            AlgorithmName = "algorithmName",

            // the properties below are optional
            ModelDataUrl = "modelDataUrl"
        } }
    },
    Tags = new [] { new CfnTag {
        Key = "key",
        Value = "value"
    } },
    Task = "task",
    ValidationSpecification = new ValidationSpecificationProperty {
        ValidationProfiles = new [] { new ValidationProfileProperty {
            ProfileName = "profileName",
            TransformJobDefinition = new TransformJobDefinitionProperty {
                TransformInput = new TransformInputProperty {
                    DataSource = new DataSourceProperty {
                        S3DataSource = new S3DataSourceProperty {
                            S3DataType = "s3DataType",
                            S3Uri = "s3Uri"
                        }
                    },

                    // the properties below are optional
                    CompressionType = "compressionType",
                    ContentType = "contentType",
                    SplitType = "splitType"
                },
                TransformOutput = new TransformOutputProperty {
                    S3OutputPath = "s3OutputPath",

                    // the properties below are optional
                    Accept = "accept",
                    AssembleWith = "assembleWith",
                    KmsKeyId = "kmsKeyId"
                },
                TransformResources = new TransformResourcesProperty {
                    InstanceCount = 123,
                    InstanceType = "instanceType",

                    // the properties below are optional
                    VolumeKmsKeyId = "volumeKmsKeyId"
                },

                // the properties below are optional
                BatchStrategy = "batchStrategy",
                Environment = new Dictionary<string, string> {
                    { "environmentKey", "environment" }
                },
                MaxConcurrentTransforms = 123,
                MaxPayloadInMb = 123
            }
        } },
        ValidationRole = "validationRole"
    }
});

Synopsis

Constructors

CfnModelPackage(Construct, String, ICfnModelPackageProps)

Create a new AWS::SageMaker::ModelPackage.

CfnModelPackage(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference

CfnModelPackage(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

Properties

AdditionalInferenceSpecificationDefinition

A structure of additional Inference Specification.

AdditionalInferenceSpecifications

An array of additional Inference Specification objects.

AdditionalInferenceSpecificationsToAdd

An array of additional Inference Specification objects to be added to the existing array.

ApprovalDescription

A description provided when the model approval is set.

AttrCreationTime

The time that the model package was created.

AttrModelPackageArn

The Amazon Resource Name (ARN) of the model package.

AttrModelPackageStatus

The status of the model package. This can be one of the following values.

CertifyForMarketplace

Whether the model package is to be certified to be listed on AWS Marketplace.

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

CfnProperties
ClientToken

A unique token that guarantees that the call to this API is idempotent.

CreatedBy

Information about the user who created or modified an experiment, trial, trial component, lineage group, or project.

CustomerMetadataProperties

The metadata properties for the model package.

Domain

The machine learning domain of your model package and its components.

DriftCheckBaselines

Represents the drift check baselines that can be used when the model monitor is set using the model package.

Environment

The environment variables to set in the Docker container.

InferenceSpecification

Defines how to perform inference generation after a training job is run.

LastModifiedBy

Information about the user who created or modified an experiment, trial, trial component, lineage group, or project.

LastModifiedTime

The last time the model package was modified.

MetadataProperties

Metadata properties of the tracking entity, trial, or trial component.

ModelApprovalStatus

The approval status of the model. This can be one of the following values.

ModelMetrics

Metrics for the model.

ModelPackageDescription

The description of the model package.

ModelPackageGroupName

The model group to which the model belongs.

ModelPackageName

The name of the model.

ModelPackageStatusDetails

Specifies the validation and image scan statuses of the model package.

ModelPackageStatusItem

Represents the overall status of a model package.

ModelPackageVersion

The version number of a versioned model.

SamplePayloadUrl

The Amazon Simple Storage Service path where the sample payload are stored.

SourceAlgorithmSpecification

A list of algorithms that were used to create a model package.

Tags

A list of the tags associated with the model package.

Task

The machine learning task your model package accomplishes.

ValidationSpecification

Specifies batch transform jobs that SageMaker runs to validate your model package.

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

RenderProperties(IDictionary<String, Object>)

Constructors

CfnModelPackage(Construct, String, ICfnModelPackageProps)

Create a new AWS::SageMaker::ModelPackage.

public CfnModelPackage(Construct scope, string id, ICfnModelPackageProps props = null)
Parameters
scope Construct
  • scope in which this resource is defined.
id System.String
  • scoped id of the resource.
props ICfnModelPackageProps
  • resource properties.

CfnModelPackage(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference

protected CfnModelPackage(ByRefValue reference)
Parameters
reference Amazon.JSII.Runtime.Deputy.ByRefValue

The Javascript-owned object reference

CfnModelPackage(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

protected CfnModelPackage(DeputyBase.DeputyProps props)
Parameters
props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps

The deputy props

Properties

AdditionalInferenceSpecificationDefinition

A structure of additional Inference Specification.

public virtual object AdditionalInferenceSpecificationDefinition { get; set; }
Property Value

System.Object

Remarks

Additional Inference Specification specifies details about inference jobs that can be run with models based on this model package

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelpackage.html#cfn-sagemaker-modelpackage-additionalinferencespecificationdefinition

AdditionalInferenceSpecifications

An array of additional Inference Specification objects.

public virtual object AdditionalInferenceSpecifications { get; set; }
Property Value

System.Object

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelpackage.html#cfn-sagemaker-modelpackage-additionalinferencespecifications

AdditionalInferenceSpecificationsToAdd

An array of additional Inference Specification objects to be added to the existing array.

public virtual object AdditionalInferenceSpecificationsToAdd { get; set; }
Property Value

System.Object

Remarks

The total number of additional Inference Specification objects cannot exceed 15. Each additional Inference Specification object specifies artifacts based on this model package that can be used on inference endpoints. Generally used with SageMaker Neo to store the compiled artifacts.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelpackage.html#cfn-sagemaker-modelpackage-additionalinferencespecificationstoadd

ApprovalDescription

A description provided when the model approval is set.

public virtual string ApprovalDescription { get; set; }
Property Value

System.String

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelpackage.html#cfn-sagemaker-modelpackage-approvaldescription

AttrCreationTime

The time that the model package was created.

public virtual string AttrCreationTime { get; }
Property Value

System.String

Remarks

CloudformationAttribute: CreationTime

AttrModelPackageArn

The Amazon Resource Name (ARN) of the model package.

public virtual string AttrModelPackageArn { get; }
Property Value

System.String

Remarks

CloudformationAttribute: ModelPackageArn

AttrModelPackageStatus

The status of the model package. This can be one of the following values.

public virtual string AttrModelPackageStatus { get; }
Property Value

System.String

Remarks

    CloudformationAttribute: ModelPackageStatus

    CertifyForMarketplace

    Whether the model package is to be certified to be listed on AWS Marketplace.

    public virtual object CertifyForMarketplace { get; set; }
    Property Value

    System.Object

    Remarks

    For information about listing model packages on AWS Marketplace, see List Your Algorithm or Model Package on AWS Marketplace .

    Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelpackage.html#cfn-sagemaker-modelpackage-certifyformarketplace

    CFN_RESOURCE_TYPE_NAME

    The CloudFormation resource type name for this resource class.

    public static string CFN_RESOURCE_TYPE_NAME { get; }
    Property Value

    System.String

    CfnProperties

    protected override IDictionary<string, object> CfnProperties { get; }
    Property Value

    System.Collections.Generic.IDictionary<System.String, System.Object>

    Overrides
    CfnResource.CfnProperties

    ClientToken

    A unique token that guarantees that the call to this API is idempotent.

    public virtual string ClientToken { get; set; }
    Property Value

    System.String

    Remarks

    Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelpackage.html#cfn-sagemaker-modelpackage-clienttoken

    CreatedBy

    Information about the user who created or modified an experiment, trial, trial component, lineage group, or project.

    public virtual object CreatedBy { get; set; }
    Property Value

    System.Object

    Remarks

    Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelpackage.html#cfn-sagemaker-modelpackage-createdby

    CustomerMetadataProperties

    The metadata properties for the model package.

    public virtual object CustomerMetadataProperties { get; set; }
    Property Value

    System.Object

    Remarks

    Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelpackage.html#cfn-sagemaker-modelpackage-customermetadataproperties

    Domain

    The machine learning domain of your model package and its components.

    public virtual string Domain { get; set; }
    Property Value

    System.String

    Remarks

    Common machine learning domains include computer vision and natural language processing.

    Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelpackage.html#cfn-sagemaker-modelpackage-domain

    DriftCheckBaselines

    Represents the drift check baselines that can be used when the model monitor is set using the model package.

    public virtual object DriftCheckBaselines { get; set; }
    Property Value

    System.Object

    Remarks

    Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelpackage.html#cfn-sagemaker-modelpackage-driftcheckbaselines

    Environment

    The environment variables to set in the Docker container.

    public virtual object Environment { get; set; }
    Property Value

    System.Object

    Remarks

    Each key and value in the Environment string to string map can have length of up to 1024. We support up to 16 entries in the map.

    Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelpackage.html#cfn-sagemaker-modelpackage-environment

    InferenceSpecification

    Defines how to perform inference generation after a training job is run.

    public virtual object InferenceSpecification { get; set; }
    Property Value

    System.Object

    Remarks

    Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelpackage.html#cfn-sagemaker-modelpackage-inferencespecification

    LastModifiedBy

    Information about the user who created or modified an experiment, trial, trial component, lineage group, or project.

    public virtual object LastModifiedBy { get; set; }
    Property Value

    System.Object

    Remarks

    Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelpackage.html#cfn-sagemaker-modelpackage-lastmodifiedby

    LastModifiedTime

    The last time the model package was modified.

    public virtual string LastModifiedTime { get; set; }
    Property Value

    System.String

    Remarks

    Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelpackage.html#cfn-sagemaker-modelpackage-lastmodifiedtime

    MetadataProperties

    Metadata properties of the tracking entity, trial, or trial component.

    public virtual object MetadataProperties { get; set; }
    Property Value

    System.Object

    Remarks

    Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelpackage.html#cfn-sagemaker-modelpackage-metadataproperties

    ModelApprovalStatus

    The approval status of the model. This can be one of the following values.

    public virtual string ModelApprovalStatus { get; set; }
    Property Value

    System.String

    Remarks

      Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelpackage.html#cfn-sagemaker-modelpackage-modelapprovalstatus

      ModelMetrics

      Metrics for the model.

      public virtual object ModelMetrics { get; set; }
      Property Value

      System.Object

      Remarks

      Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelpackage.html#cfn-sagemaker-modelpackage-modelmetrics

      ModelPackageDescription

      The description of the model package.

      public virtual string ModelPackageDescription { get; set; }
      Property Value

      System.String

      Remarks

      Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelpackage.html#cfn-sagemaker-modelpackage-modelpackagedescription

      ModelPackageGroupName

      The model group to which the model belongs.

      public virtual string ModelPackageGroupName { get; set; }
      Property Value

      System.String

      Remarks

      Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelpackage.html#cfn-sagemaker-modelpackage-modelpackagegroupname

      ModelPackageName

      The name of the model.

      public virtual string ModelPackageName { get; set; }
      Property Value

      System.String

      Remarks

      Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelpackage.html#cfn-sagemaker-modelpackage-modelpackagename

      ModelPackageStatusDetails

      Specifies the validation and image scan statuses of the model package.

      public virtual object ModelPackageStatusDetails { get; set; }
      Property Value

      System.Object

      Remarks

      Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelpackage.html#cfn-sagemaker-modelpackage-modelpackagestatusdetails

      ModelPackageStatusItem

      Represents the overall status of a model package.

      public virtual object ModelPackageStatusItem { get; set; }
      Property Value

      System.Object

      Remarks

      Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelpackage.html#cfn-sagemaker-modelpackage-modelpackagestatusitem

      ModelPackageVersion

      The version number of a versioned model.

      public virtual Nullable<double> ModelPackageVersion { get; set; }
      Property Value

      System.Nullable<System.Double>

      Remarks

      Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelpackage.html#cfn-sagemaker-modelpackage-modelpackageversion

      SamplePayloadUrl

      The Amazon Simple Storage Service path where the sample payload are stored.

      public virtual string SamplePayloadUrl { get; set; }
      Property Value

      System.String

      Remarks

      This path must point to a single gzip compressed tar archive (.tar.gz suffix).

      Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelpackage.html#cfn-sagemaker-modelpackage-samplepayloadurl

      SourceAlgorithmSpecification

      A list of algorithms that were used to create a model package.

      public virtual object SourceAlgorithmSpecification { get; set; }
      Property Value

      System.Object

      Remarks

      Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelpackage.html#cfn-sagemaker-modelpackage-sourcealgorithmspecification

      Tags

      A list of the tags associated with the model package.

      public virtual TagManager Tags { get; }
      Property Value

      TagManager

      Remarks

      For more information, see Tagging AWS resources in the AWS General Reference Guide .

      Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelpackage.html#cfn-sagemaker-modelpackage-tags

      Task

      The machine learning task your model package accomplishes.

      public virtual string Task { get; set; }
      Property Value

      System.String

      Remarks

      Common machine learning tasks include object detection and image classification.

      Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelpackage.html#cfn-sagemaker-modelpackage-task

      ValidationSpecification

      Specifies batch transform jobs that SageMaker runs to validate your model package.

      public virtual object ValidationSpecification { get; set; }
      Property Value

      System.Object

      Remarks

      Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelpackage.html#cfn-sagemaker-modelpackage-validationspecification

      Methods

      Inspect(TreeInspector)

      Examines the CloudFormation resource and discloses attributes.

      public virtual void Inspect(TreeInspector inspector)
      Parameters
      inspector TreeInspector
      • tree inspector to collect and process attributes.

      RenderProperties(IDictionary<String, Object>)

      protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
      Parameters
      props System.Collections.Generic.IDictionary<System.String, System.Object>
      Returns

      System.Collections.Generic.IDictionary<System.String, System.Object>

      Overrides
      CfnResource.RenderProperties(IDictionary<String, Object>)

      Implements

      IConstruct
      Constructs.IConstruct
      IDependable
      IInspectable
      Back to top Generated by DocFX