Package software.amazon.awscdk.services.sagemaker

Interface CfnModelCard.ModelPackageDetailsProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnModelCard.ModelPackageDetailsProperty.Jsii$Proxy

Enclosing class:

CfnModelCard

@Stability(Stable)
public static interface CfnModelCard.ModelPackageDetailsProperty
extends software.amazon.jsii.JsiiSerializable

Metadata information related to model package version.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.sagemaker.*;
 ModelPackageDetailsProperty modelPackageDetailsProperty = ModelPackageDetailsProperty.builder()
         .approvalDescription("approvalDescription")
         .createdBy(ModelPackageCreatorProperty.builder()
                 .userProfileName("userProfileName")
                 .build())
         .domain("domain")
         .inferenceSpecification(InferenceSpecificationProperty.builder()
                 .containers(List.of(ContainerProperty.builder()
                         .image("image")
                         // the properties below are optional
                         .modelDataUrl("modelDataUrl")
                         .nearestModelName("nearestModelName")
                         .build()))
                 .build())
         .modelApprovalStatus("modelApprovalStatus")
         .modelPackageArn("modelPackageArn")
         .modelPackageDescription("modelPackageDescription")
         .modelPackageGroupName("modelPackageGroupName")
         .modelPackageName("modelPackageName")
         .modelPackageStatus("modelPackageStatus")
         .modelPackageVersion(123)
         .sourceAlgorithms(List.of(SourceAlgorithmProperty.builder()
                 .algorithmName("algorithmName")
                 // the properties below are optional
                 .modelDataUrl("modelDataUrl")
                 .build()))
         .task("task")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-modelpackagedetails.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnModelCard.ModelPackageDetailsProperty.Builder	A builder for CfnModelCard.ModelPackageDetailsProperty
static final class	CfnModelCard.ModelPackageDetailsProperty.Jsii$Proxy	An implementation for CfnModelCard.ModelPackageDetailsProperty

Method Summary

Modifier and Type	Method	Description
static CfnModelCard.ModelPackageDetailsProperty.Builder	builder()
default String	getApprovalDescription()	A description provided for the model approval.
default Object	getCreatedBy()	Returns union: either IResolvable or CfnModelCard.ModelPackageCreatorProperty
default String	getDomain()	The machine learning domain of the model package you specified.
default Object	getInferenceSpecification()	Returns union: either IResolvable or CfnModelCard.InferenceSpecificationProperty
default String	getModelApprovalStatus()	Current approval status of model package.
default String	getModelPackageArn()	The Amazon Resource Name (ARN) of the model package.
default String	getModelPackageDescription()	A brief summary of the model package.
default String	getModelPackageGroupName()	If the model is a versioned model, the name of the model group that the versioned model belongs to.
default String	getModelPackageName()	Name of the model package.
default String	getModelPackageStatus()	Current status of model package.
default Number	getModelPackageVersion()	Version of the model package.
default Object	getSourceAlgorithms()	Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnModelCard.SourceAlgorithmProperty>
default String	getTask()	The machine learning task you specified that your model package accomplishes.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getApprovalDescription

@Stability(Stable)
@Nullable
default String getApprovalDescription()

A description provided for the model approval.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-modelpackagedetails.html#cfn-sagemaker-modelcard-modelpackagedetails-approvaldescription

getCreatedBy

@Stability(Stable)
@Nullable
default Object getCreatedBy()

Returns union: either IResolvable or CfnModelCard.ModelPackageCreatorProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-modelpackagedetails.html#cfn-sagemaker-modelcard-modelpackagedetails-createdby

getDomain

@Stability(Stable)
@Nullable
default String getDomain()

The machine learning domain of the model package you specified.

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-modelpackagedetails.html#cfn-sagemaker-modelcard-modelpackagedetails-domain

getInferenceSpecification

@Stability(Stable)
@Nullable
default Object getInferenceSpecification()

Returns union: either IResolvable or CfnModelCard.InferenceSpecificationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-modelpackagedetails.html#cfn-sagemaker-modelcard-modelpackagedetails-inferencespecification

getModelApprovalStatus

@Stability(Stable)
@Nullable
default String getModelApprovalStatus()

Current approval status of model package.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-modelpackagedetails.html#cfn-sagemaker-modelcard-modelpackagedetails-modelapprovalstatus

getModelPackageArn

@Stability(Stable)
@Nullable
default String getModelPackageArn()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-modelpackagedetails.html#cfn-sagemaker-modelcard-modelpackagedetails-modelpackagearn

getModelPackageDescription

@Stability(Stable)
@Nullable
default String getModelPackageDescription()

A brief summary of the model package.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-modelpackagedetails.html#cfn-sagemaker-modelcard-modelpackagedetails-modelpackagedescription

getModelPackageGroupName

@Stability(Stable)
@Nullable
default String getModelPackageGroupName()

If the model is a versioned model, the name of the model group that the versioned model belongs to.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-modelpackagedetails.html#cfn-sagemaker-modelcard-modelpackagedetails-modelpackagegroupname

getModelPackageName

@Stability(Stable)
@Nullable
default String getModelPackageName()

Name of the model package.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-modelpackagedetails.html#cfn-sagemaker-modelcard-modelpackagedetails-modelpackagename

getModelPackageStatus

@Stability(Stable)
@Nullable
default String getModelPackageStatus()

Current status of model package.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-modelpackagedetails.html#cfn-sagemaker-modelcard-modelpackagedetails-modelpackagestatus

getModelPackageVersion

@Stability(Stable)
@Nullable
default Number getModelPackageVersion()

Version of the model package.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-modelpackagedetails.html#cfn-sagemaker-modelcard-modelpackagedetails-modelpackageversion

getSourceAlgorithms

@Stability(Stable)
@Nullable
default Object getSourceAlgorithms()

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnModelCard.SourceAlgorithmProperty>

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-modelpackagedetails.html#cfn-sagemaker-modelcard-modelpackagedetails-sourcealgorithms

getTask

@Stability(Stable)
@Nullable
default String getTask()

The machine learning task you specified that your model package accomplishes.

Common machine learning tasks include object detection and image classification.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-modelpackagedetails.html#cfn-sagemaker-modelcard-modelpackagedetails-task

builder

@Stability(Stable)
static CfnModelCard.ModelPackageDetailsProperty.Builder builder()

Returns:

a CfnModelCard.ModelPackageDetailsProperty.Builder of CfnModelCard.ModelPackageDetailsProperty