Package software.amazon.awscdk.services.sagemaker

Interface CfnModelCard.IntendedUsesProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnModelCard.IntendedUsesProperty.Jsii$Proxy

Enclosing class:

CfnModelCard

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

The intended uses of a 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.*;
 IntendedUsesProperty intendedUsesProperty = IntendedUsesProperty.builder()
         .explanationsForRiskRating("explanationsForRiskRating")
         .factorsAffectingModelEfficiency("factorsAffectingModelEfficiency")
         .intendedUses("intendedUses")
         .purposeOfModel("purposeOfModel")
         .riskRating("riskRating")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnModelCard.IntendedUsesProperty.Builder	builder()
default String	getExplanationsForRiskRating()	An explanation of why your organization categorizes the model with its risk rating.
default String	getFactorsAffectingModelEfficiency()	Factors affecting model efficacy.
default String	getIntendedUses()	The intended use cases for the model.
default String	getPurposeOfModel()	The general purpose of the model.
default String	getRiskRating()	Your organization's risk rating.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getExplanationsForRiskRating

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

An explanation of why your organization categorizes the model with its risk rating.

See Also:

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

getFactorsAffectingModelEfficiency

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

Factors affecting model efficacy.

See Also:

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

getIntendedUses

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

The intended use cases for the model.

See Also:

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

getPurposeOfModel

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

The general purpose of the model.

See Also:

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

getRiskRating

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

Your organization's risk rating. You can specify one the following values as the risk rating:.

• High
• Medium
• Low
• Unknown

See Also:

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

builder

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

Returns:

a CfnModelCard.IntendedUsesProperty.Builder of CfnModelCard.IntendedUsesProperty