Package software.amazon.awscdk.services.sagemaker

Interface CfnModelCard.ModelOverviewProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnModelCard.ModelOverviewProperty.Jsii$Proxy

Enclosing class:

CfnModelCard

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

An overview about the model.

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.*;
 ModelOverviewProperty modelOverviewProperty = ModelOverviewProperty.builder()
         .algorithmType("algorithmType")
         .inferenceEnvironment(InferenceEnvironmentProperty.builder()
                 .containerImage(List.of("containerImage"))
                 .build())
         .modelArtifact(List.of("modelArtifact"))
         .modelCreator("modelCreator")
         .modelDescription("modelDescription")
         .modelId("modelId")
         .modelName("modelName")
         .modelOwner("modelOwner")
         .modelVersion(123)
         .problemType("problemType")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnModelCard.ModelOverviewProperty.Builder	builder()
default String	getAlgorithmType()	The algorithm used to solve the problem.
default Object	getInferenceEnvironment()	An overview about model inference.
default List<String>	getModelArtifact()	The location of the model artifact.
default String	getModelCreator()	The creator of the model.
default String	getModelDescription()	A description of the model.
default String	getModelId()	The SageMaker AI Model ARN or non- SageMaker AI Model ID.
default String	getModelName()	The name of the model.
default String	getModelOwner()	The owner of the model.
default Number	getModelVersion()	The version of the model.
default String	getProblemType()	The problem being solved with the model.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAlgorithmType

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

The algorithm used to solve the problem.

See Also:

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

getInferenceEnvironment

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

An overview about model inference.

Returns union: either IResolvable or CfnModelCard.InferenceEnvironmentProperty

See Also:

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

getModelArtifact

@Stability(Stable)
@Nullable
default List<String> getModelArtifact()

The location of the model artifact.

See Also:

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

getModelCreator

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

The creator of the model.

See Also:

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

getModelDescription

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

A description of the model.

See Also:

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

getModelId

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

The SageMaker AI Model ARN or non- SageMaker AI Model ID.

See Also:

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

getModelName

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

The name of the model.

See Also:

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

getModelOwner

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

The owner of the model.

See Also:

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

getModelVersion

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

The version of the model.

See Also:

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

getProblemType

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

The problem being solved with the model.

See Also:

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

builder

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

Returns:

a CfnModelCard.ModelOverviewProperty.Builder of CfnModelCard.ModelOverviewProperty