This is the new *CloudFormation Template Reference Guide*. Please update your bookmarks and links. For help getting started with CloudFormation, see the [AWS CloudFormation User Guide](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/Welcome.html).

# AWS::SageMaker::ModelCard
<a name="aws-resource-sagemaker-modelcard"></a>

Creates an Amazon SageMaker Model Card.

For information about how to use model cards, see [Amazon SageMaker Model Card](https://docs.aws.amazon.com/sagemaker/latest/dg/model-cards.html).

## Syntax
<a name="aws-resource-sagemaker-modelcard-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-resource-sagemaker-modelcard-syntax.json"></a>

```
{
  "Type" : "AWS::SageMaker::ModelCard",
  "Properties" : {
      "[Content](#cfn-sagemaker-modelcard-content)" : Content,
      "[CreatedBy](#cfn-sagemaker-modelcard-createdby)" : UserContext,
      "[LastModifiedBy](#cfn-sagemaker-modelcard-lastmodifiedby)" : UserContext,
      "[ModelCardName](#cfn-sagemaker-modelcard-modelcardname)" : String,
      "[ModelCardStatus](#cfn-sagemaker-modelcard-modelcardstatus)" : String,
      "[SecurityConfig](#cfn-sagemaker-modelcard-securityconfig)" : SecurityConfig,
      "[Tags](#cfn-sagemaker-modelcard-tags)" : [ Tag, ... ]
    }
}
```

### YAML
<a name="aws-resource-sagemaker-modelcard-syntax.yaml"></a>

```
Type: AWS::SageMaker::ModelCard
Properties:
  [Content](#cfn-sagemaker-modelcard-content): 
    Content
  [CreatedBy](#cfn-sagemaker-modelcard-createdby): 
    UserContext
  [LastModifiedBy](#cfn-sagemaker-modelcard-lastmodifiedby): 
    UserContext
  [ModelCardName](#cfn-sagemaker-modelcard-modelcardname): String
  [ModelCardStatus](#cfn-sagemaker-modelcard-modelcardstatus): String
  [SecurityConfig](#cfn-sagemaker-modelcard-securityconfig): 
    SecurityConfig
  [Tags](#cfn-sagemaker-modelcard-tags): 
    - Tag
```

## Properties
<a name="aws-resource-sagemaker-modelcard-properties"></a>

`Content`  <a name="cfn-sagemaker-modelcard-content"></a>
The content of the model card. Content uses the [model card JSON schema](https://docs.aws.amazon.com/sagemaker/latest/dg/model-cards.html#model-cards-json-schema).  
*Required*: Yes  
*Type*: [Content](aws-properties-sagemaker-modelcard-content.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`CreatedBy`  <a name="cfn-sagemaker-modelcard-createdby"></a>
Information about the user who created or modified one or more of the following:  
+ Experiment
+ Trial
+ Trial component
+ Lineage group
+ Project
+ Model Card
*Required*: No  
*Type*: [UserContext](aws-properties-sagemaker-modelcard-usercontext.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`LastModifiedBy`  <a name="cfn-sagemaker-modelcard-lastmodifiedby"></a>
Information about the user who last modified the model card.  
*Required*: No  
*Type*: [UserContext](aws-properties-sagemaker-modelcard-usercontext.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ModelCardName`  <a name="cfn-sagemaker-modelcard-modelcardname"></a>
The unique name of the model card.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$`  
*Maximum*: `63`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`ModelCardStatus`  <a name="cfn-sagemaker-modelcard-modelcardstatus"></a>
The approval status of the model card within your organization. Different organizations might have different criteria for model card review and approval.  
+ `Draft`: The model card is a work in progress.
+ `PendingReview`: The model card is pending review.
+ `Approved`: The model card is approved.
+ `Archived`: The model card is archived. No more updates should be made to the model card, but it can still be exported.
*Required*: Yes  
*Type*: String  
*Allowed values*: `Draft | PendingReview | Approved | Archived`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`SecurityConfig`  <a name="cfn-sagemaker-modelcard-securityconfig"></a>
The security configuration used to protect model card data.  
*Required*: No  
*Type*: [SecurityConfig](aws-properties-sagemaker-modelcard-securityconfig.md)  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Tags`  <a name="cfn-sagemaker-modelcard-tags"></a>
Key-value pairs used to manage metadata for the model card.  
*Required*: No  
*Type*: Array of [Tag](aws-properties-sagemaker-modelcard-tag.md)  
*Minimum*: `1`  
*Maximum*: `50`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

## Return values
<a name="aws-resource-sagemaker-modelcard-return-values"></a>

### Ref
<a name="aws-resource-sagemaker-modelcard-return-values-ref"></a>

When you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the model card name.

For more information about using the `Ref` function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).

### Fn::GetAtt
<a name="aws-resource-sagemaker-modelcard-return-values-fn--getatt"></a>

The `Fn::GetAtt` intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the `Fn::GetAtt` intrinsic function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html).

#### 
<a name="aws-resource-sagemaker-modelcard-return-values-fn--getatt-fn--getatt"></a>

`CreatedBy.DomainId`  <a name="CreatedBy.DomainId-fn::getatt"></a>
Property description not available.

`LastModifiedBy.UserProfileArn`  <a name="LastModifiedBy.UserProfileArn-fn::getatt"></a>
Property description not available.

`ModelCardArn`  <a name="ModelCardArn-fn::getatt"></a>
The Amazon Resource Number (ARN) of the model card. For example, `arn:aws:sagemaker:us-west-2:012345678901:modelcard/examplemodelcard`.

# AWS::SageMaker::ModelCard AdditionalInformation
<a name="aws-properties-sagemaker-modelcard-additionalinformation"></a>

Additional information about the model.

## Syntax
<a name="aws-properties-sagemaker-modelcard-additionalinformation-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-sagemaker-modelcard-additionalinformation-syntax.json"></a>

```
{
  "[CaveatsAndRecommendations](#cfn-sagemaker-modelcard-additionalinformation-caveatsandrecommendations)" : String,
  "[CustomDetails](#cfn-sagemaker-modelcard-additionalinformation-customdetails)" : {Key: Value, ...},
  "[EthicalConsiderations](#cfn-sagemaker-modelcard-additionalinformation-ethicalconsiderations)" : String
}
```

### YAML
<a name="aws-properties-sagemaker-modelcard-additionalinformation-syntax.yaml"></a>

```
  [CaveatsAndRecommendations](#cfn-sagemaker-modelcard-additionalinformation-caveatsandrecommendations): String
  [CustomDetails](#cfn-sagemaker-modelcard-additionalinformation-customdetails): 
    Key: Value
  [EthicalConsiderations](#cfn-sagemaker-modelcard-additionalinformation-ethicalconsiderations): String
```

## Properties
<a name="aws-properties-sagemaker-modelcard-additionalinformation-properties"></a>

`CaveatsAndRecommendations`  <a name="cfn-sagemaker-modelcard-additionalinformation-caveatsandrecommendations"></a>
Caveats and recommendations for those who might use this model in their applications.  
*Required*: No  
*Type*: String  
*Maximum*: `2048`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`CustomDetails`  <a name="cfn-sagemaker-modelcard-additionalinformation-customdetails"></a>
Any additional information to document about the model.  
*Required*: No  
*Type*: Object of String  
*Pattern*: `[a-zA-Z_][a-zA-Z0-9_]*`  
*Maximum*: `1024`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`EthicalConsiderations`  <a name="cfn-sagemaker-modelcard-additionalinformation-ethicalconsiderations"></a>
Any ethical considerations documented by the model card author.  
*Required*: No  
*Type*: String  
*Maximum*: `2048`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::SageMaker::ModelCard BusinessDetails
<a name="aws-properties-sagemaker-modelcard-businessdetails"></a>

Information about how the model supports business goals.

## Syntax
<a name="aws-properties-sagemaker-modelcard-businessdetails-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-sagemaker-modelcard-businessdetails-syntax.json"></a>

```
{
  "[BusinessProblem](#cfn-sagemaker-modelcard-businessdetails-businessproblem)" : String,
  "[BusinessStakeholders](#cfn-sagemaker-modelcard-businessdetails-businessstakeholders)" : String,
  "[LineOfBusiness](#cfn-sagemaker-modelcard-businessdetails-lineofbusiness)" : String
}
```

### YAML
<a name="aws-properties-sagemaker-modelcard-businessdetails-syntax.yaml"></a>

```
  [BusinessProblem](#cfn-sagemaker-modelcard-businessdetails-businessproblem): String
  [BusinessStakeholders](#cfn-sagemaker-modelcard-businessdetails-businessstakeholders): String
  [LineOfBusiness](#cfn-sagemaker-modelcard-businessdetails-lineofbusiness): String
```

## Properties
<a name="aws-properties-sagemaker-modelcard-businessdetails-properties"></a>

`BusinessProblem`  <a name="cfn-sagemaker-modelcard-businessdetails-businessproblem"></a>
The specific business problem that the model is trying to solve.  
*Required*: No  
*Type*: String  
*Maximum*: `2048`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`BusinessStakeholders`  <a name="cfn-sagemaker-modelcard-businessdetails-businessstakeholders"></a>
The relevant stakeholders for the model.  
*Required*: No  
*Type*: String  
*Maximum*: `2048`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`LineOfBusiness`  <a name="cfn-sagemaker-modelcard-businessdetails-lineofbusiness"></a>
The broader business need that the model is serving.  
*Required*: No  
*Type*: String  
*Maximum*: `2048`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::SageMaker::ModelCard Container
<a name="aws-properties-sagemaker-modelcard-container"></a>

Information about the container used for the model.

## Syntax
<a name="aws-properties-sagemaker-modelcard-container-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-sagemaker-modelcard-container-syntax.json"></a>

```
{
  "[Image](#cfn-sagemaker-modelcard-container-image)" : String,
  "[ModelDataUrl](#cfn-sagemaker-modelcard-container-modeldataurl)" : String,
  "[NearestModelName](#cfn-sagemaker-modelcard-container-nearestmodelname)" : String
}
```

### YAML
<a name="aws-properties-sagemaker-modelcard-container-syntax.yaml"></a>

```
  [Image](#cfn-sagemaker-modelcard-container-image): String
  [ModelDataUrl](#cfn-sagemaker-modelcard-container-modeldataurl): String
  [NearestModelName](#cfn-sagemaker-modelcard-container-nearestmodelname): String
```

## Properties
<a name="aws-properties-sagemaker-modelcard-container-properties"></a>

`Image`  <a name="cfn-sagemaker-modelcard-container-image"></a>
The Amazon EC2 Container Registry (Amazon ECR) path where the model container image is stored.  
*Required*: Yes  
*Type*: String  
*Maximum*: `255`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ModelDataUrl`  <a name="cfn-sagemaker-modelcard-container-modeldataurl"></a>
The Amazon S3 path where the model artifacts are stored.  
*Required*: No  
*Type*: String  
*Maximum*: `1024`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`NearestModelName`  <a name="cfn-sagemaker-modelcard-container-nearestmodelname"></a>
The name of a pre-trained model in the registry that is similar to this model.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::SageMaker::ModelCard Content
<a name="aws-properties-sagemaker-modelcard-content"></a>

The content of the model card. It follows the [model card json schema](https://docs.aws.amazon.com/sagemaker/latest/dg/model-cards.html#model-cards-json-schema).

## Syntax
<a name="aws-properties-sagemaker-modelcard-content-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-sagemaker-modelcard-content-syntax.json"></a>

```
{
  "[AdditionalInformation](#cfn-sagemaker-modelcard-content-additionalinformation)" : AdditionalInformation,
  "[BusinessDetails](#cfn-sagemaker-modelcard-content-businessdetails)" : BusinessDetails,
  "[EvaluationDetails](#cfn-sagemaker-modelcard-content-evaluationdetails)" : [ EvaluationDetail, ... ],
  "[IntendedUses](#cfn-sagemaker-modelcard-content-intendeduses)" : IntendedUses,
  "[ModelOverview](#cfn-sagemaker-modelcard-content-modeloverview)" : ModelOverview,
  "[ModelPackageDetails](#cfn-sagemaker-modelcard-content-modelpackagedetails)" : ModelPackageDetails,
  "[TrainingDetails](#cfn-sagemaker-modelcard-content-trainingdetails)" : TrainingDetails
}
```

### YAML
<a name="aws-properties-sagemaker-modelcard-content-syntax.yaml"></a>

```
  [AdditionalInformation](#cfn-sagemaker-modelcard-content-additionalinformation): 
    AdditionalInformation
  [BusinessDetails](#cfn-sagemaker-modelcard-content-businessdetails): 
    BusinessDetails
  [EvaluationDetails](#cfn-sagemaker-modelcard-content-evaluationdetails): 
    - EvaluationDetail
  [IntendedUses](#cfn-sagemaker-modelcard-content-intendeduses): 
    IntendedUses
  [ModelOverview](#cfn-sagemaker-modelcard-content-modeloverview): 
    ModelOverview
  [ModelPackageDetails](#cfn-sagemaker-modelcard-content-modelpackagedetails): 
    ModelPackageDetails
  [TrainingDetails](#cfn-sagemaker-modelcard-content-trainingdetails): 
    TrainingDetails
```

## Properties
<a name="aws-properties-sagemaker-modelcard-content-properties"></a>

`AdditionalInformation`  <a name="cfn-sagemaker-modelcard-content-additionalinformation"></a>
Additional information about the model.  
*Required*: No  
*Type*: [AdditionalInformation](aws-properties-sagemaker-modelcard-additionalinformation.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`BusinessDetails`  <a name="cfn-sagemaker-modelcard-content-businessdetails"></a>
Information about how the model supports business goals.  
*Required*: No  
*Type*: [BusinessDetails](aws-properties-sagemaker-modelcard-businessdetails.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`EvaluationDetails`  <a name="cfn-sagemaker-modelcard-content-evaluationdetails"></a>
An overview about the model's evaluation.  
*Required*: No  
*Type*: Array of [EvaluationDetail](aws-properties-sagemaker-modelcard-evaluationdetail.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`IntendedUses`  <a name="cfn-sagemaker-modelcard-content-intendeduses"></a>
The intended usage of the model.  
*Required*: No  
*Type*: [IntendedUses](aws-properties-sagemaker-modelcard-intendeduses.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ModelOverview`  <a name="cfn-sagemaker-modelcard-content-modeloverview"></a>
An overview about the model  
*Required*: No  
*Type*: [ModelOverview](aws-properties-sagemaker-modelcard-modeloverview.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ModelPackageDetails`  <a name="cfn-sagemaker-modelcard-content-modelpackagedetails"></a>
Details about the model package.  
*Required*: No  
*Type*: [ModelPackageDetails](aws-properties-sagemaker-modelcard-modelpackagedetails.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`TrainingDetails`  <a name="cfn-sagemaker-modelcard-content-trainingdetails"></a>
An overview about model training.  
*Required*: No  
*Type*: [TrainingDetails](aws-properties-sagemaker-modelcard-trainingdetails.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::SageMaker::ModelCard EvaluationDetail
<a name="aws-properties-sagemaker-modelcard-evaluationdetail"></a>

The evaluation details of the model.

## Syntax
<a name="aws-properties-sagemaker-modelcard-evaluationdetail-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-sagemaker-modelcard-evaluationdetail-syntax.json"></a>

```
{
  "[Datasets](#cfn-sagemaker-modelcard-evaluationdetail-datasets)" : [ String, ... ],
  "[EvaluationJobArn](#cfn-sagemaker-modelcard-evaluationdetail-evaluationjobarn)" : String,
  "[EvaluationObservation](#cfn-sagemaker-modelcard-evaluationdetail-evaluationobservation)" : String,
  "[Metadata](#cfn-sagemaker-modelcard-evaluationdetail-metadata)" : {Key: Value, ...},
  "[MetricGroups](#cfn-sagemaker-modelcard-evaluationdetail-metricgroups)" : [ MetricGroup, ... ],
  "[Name](#cfn-sagemaker-modelcard-evaluationdetail-name)" : String
}
```

### YAML
<a name="aws-properties-sagemaker-modelcard-evaluationdetail-syntax.yaml"></a>

```
  [Datasets](#cfn-sagemaker-modelcard-evaluationdetail-datasets): 
    - String
  [EvaluationJobArn](#cfn-sagemaker-modelcard-evaluationdetail-evaluationjobarn): String
  [EvaluationObservation](#cfn-sagemaker-modelcard-evaluationdetail-evaluationobservation): String
  [Metadata](#cfn-sagemaker-modelcard-evaluationdetail-metadata): 
    Key: Value
  [MetricGroups](#cfn-sagemaker-modelcard-evaluationdetail-metricgroups): 
    - MetricGroup
  [Name](#cfn-sagemaker-modelcard-evaluationdetail-name): String
```

## Properties
<a name="aws-properties-sagemaker-modelcard-evaluationdetail-properties"></a>

`Datasets`  <a name="cfn-sagemaker-modelcard-evaluationdetail-datasets"></a>
The location of the datasets used to evaluate the model.  
*Required*: No  
*Type*: Array of String  
*Maximum*: `1024 | 10`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`EvaluationJobArn`  <a name="cfn-sagemaker-modelcard-evaluationdetail-evaluationjobarn"></a>
The Amazon Resource Name (ARN) of the evaluation job.  
*Required*: No  
*Type*: String  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`EvaluationObservation`  <a name="cfn-sagemaker-modelcard-evaluationdetail-evaluationobservation"></a>
Any observations made during the model evaluation.  
*Required*: No  
*Type*: String  
*Maximum*: `2096`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Metadata`  <a name="cfn-sagemaker-modelcard-evaluationdetail-metadata"></a>
Additional attributes associated with the evaluation results.  
*Required*: No  
*Type*: Object of String  
*Pattern*: `[a-zA-Z_][a-zA-Z0-9_]*`  
*Maximum*: `1024`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`MetricGroups`  <a name="cfn-sagemaker-modelcard-evaluationdetail-metricgroups"></a>
An evaluation Metric Group object.  
*Required*: No  
*Type*: Array of [MetricGroup](aws-properties-sagemaker-modelcard-metricgroup.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Name`  <a name="cfn-sagemaker-modelcard-evaluationdetail-name"></a>
The evaluation job name.  
*Required*: Yes  
*Type*: String  
*Pattern*: `.{1,63}`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::SageMaker::ModelCard Function
<a name="aws-properties-sagemaker-modelcard-function"></a>

Function details.

## Syntax
<a name="aws-properties-sagemaker-modelcard-function-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-sagemaker-modelcard-function-syntax.json"></a>

```
{
  "[Condition](#cfn-sagemaker-modelcard-function-condition)" : String,
  "[Facet](#cfn-sagemaker-modelcard-function-facet)" : String,
  "[Function](#cfn-sagemaker-modelcard-function-function)" : String
}
```

### YAML
<a name="aws-properties-sagemaker-modelcard-function-syntax.yaml"></a>

```
  [Condition](#cfn-sagemaker-modelcard-function-condition): String
  [Facet](#cfn-sagemaker-modelcard-function-facet): String
  [Function](#cfn-sagemaker-modelcard-function-function): String
```

## Properties
<a name="aws-properties-sagemaker-modelcard-function-properties"></a>

`Condition`  <a name="cfn-sagemaker-modelcard-function-condition"></a>
An optional description of any conditions of your objective function metric.  
*Required*: No  
*Type*: String  
*Maximum*: `63`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Facet`  <a name="cfn-sagemaker-modelcard-function-facet"></a>
The metric of the model's objective function. For example, *loss* or *rmse*. The following list shows examples of the values that you can specify for the metric:  
+  `ACCURACY` 
+  `AUC` 
+  `LOSS` 
+  `MAE` 
+  `RMSE` 
*Required*: No  
*Type*: String  
*Maximum*: `63`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Function`  <a name="cfn-sagemaker-modelcard-function-function"></a>
The optimization direction of the model's objective function. You must specify one of the following values:  
+  `Maximize` 
+  `Minimize` 
*Required*: No  
*Type*: [String](#aws-properties-sagemaker-modelcard-function)  
*Allowed values*: `Maximize | Minimize`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::SageMaker::ModelCard InferenceEnvironment
<a name="aws-properties-sagemaker-modelcard-inferenceenvironment"></a>

An overview of a model's inference environment.

## Syntax
<a name="aws-properties-sagemaker-modelcard-inferenceenvironment-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-sagemaker-modelcard-inferenceenvironment-syntax.json"></a>

```
{
  "[ContainerImage](#cfn-sagemaker-modelcard-inferenceenvironment-containerimage)" : [ String, ... ]
}
```

### YAML
<a name="aws-properties-sagemaker-modelcard-inferenceenvironment-syntax.yaml"></a>

```
  [ContainerImage](#cfn-sagemaker-modelcard-inferenceenvironment-containerimage): 
    - String
```

## Properties
<a name="aws-properties-sagemaker-modelcard-inferenceenvironment-properties"></a>

`ContainerImage`  <a name="cfn-sagemaker-modelcard-inferenceenvironment-containerimage"></a>
The container used to run the inference environment.  
*Required*: No  
*Type*: Array of String  
*Maximum*: `1024 | 15`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::SageMaker::ModelCard InferenceSpecification
<a name="aws-properties-sagemaker-modelcard-inferencespecification"></a>

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

## Syntax
<a name="aws-properties-sagemaker-modelcard-inferencespecification-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-sagemaker-modelcard-inferencespecification-syntax.json"></a>

```
{
  "[Containers](#cfn-sagemaker-modelcard-inferencespecification-containers)" : [ Container, ... ]
}
```

### YAML
<a name="aws-properties-sagemaker-modelcard-inferencespecification-syntax.yaml"></a>

```
  [Containers](#cfn-sagemaker-modelcard-inferencespecification-containers): 
    - Container
```

## Properties
<a name="aws-properties-sagemaker-modelcard-inferencespecification-properties"></a>

`Containers`  <a name="cfn-sagemaker-modelcard-inferencespecification-containers"></a>
The Amazon ECR registry path of the Docker image that contains the inference code.  
*Required*: Yes  
*Type*: Array of [Container](aws-properties-sagemaker-modelcard-container.md)  
*Minimum*: `1`  
*Maximum*: `15`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::SageMaker::ModelCard IntendedUses
<a name="aws-properties-sagemaker-modelcard-intendeduses"></a>

The intended uses of a model.

## Syntax
<a name="aws-properties-sagemaker-modelcard-intendeduses-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-sagemaker-modelcard-intendeduses-syntax.json"></a>

```
{
  "[ExplanationsForRiskRating](#cfn-sagemaker-modelcard-intendeduses-explanationsforriskrating)" : String,
  "[FactorsAffectingModelEfficiency](#cfn-sagemaker-modelcard-intendeduses-factorsaffectingmodelefficiency)" : String,
  "[IntendedUses](#cfn-sagemaker-modelcard-intendeduses-intendeduses)" : String,
  "[PurposeOfModel](#cfn-sagemaker-modelcard-intendeduses-purposeofmodel)" : String,
  "[RiskRating](#cfn-sagemaker-modelcard-intendeduses-riskrating)" : String
}
```

### YAML
<a name="aws-properties-sagemaker-modelcard-intendeduses-syntax.yaml"></a>

```
  [ExplanationsForRiskRating](#cfn-sagemaker-modelcard-intendeduses-explanationsforriskrating): String
  [FactorsAffectingModelEfficiency](#cfn-sagemaker-modelcard-intendeduses-factorsaffectingmodelefficiency): String
  [IntendedUses](#cfn-sagemaker-modelcard-intendeduses-intendeduses): String
  [PurposeOfModel](#cfn-sagemaker-modelcard-intendeduses-purposeofmodel): String
  [RiskRating](#cfn-sagemaker-modelcard-intendeduses-riskrating): String
```

## Properties
<a name="aws-properties-sagemaker-modelcard-intendeduses-properties"></a>

`ExplanationsForRiskRating`  <a name="cfn-sagemaker-modelcard-intendeduses-explanationsforriskrating"></a>
An explanation of why your organization categorizes the model with its risk rating.  
*Required*: No  
*Type*: String  
*Maximum*: `2048`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`FactorsAffectingModelEfficiency`  <a name="cfn-sagemaker-modelcard-intendeduses-factorsaffectingmodelefficiency"></a>
Factors affecting model efficacy.  
*Required*: No  
*Type*: String  
*Maximum*: `2048`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`IntendedUses`  <a name="cfn-sagemaker-modelcard-intendeduses-intendeduses"></a>
The intended use cases for the model.  
*Required*: No  
*Type*: [String](#aws-properties-sagemaker-modelcard-intendeduses)  
*Maximum*: `2048`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`PurposeOfModel`  <a name="cfn-sagemaker-modelcard-intendeduses-purposeofmodel"></a>
The general purpose of the model.  
*Required*: No  
*Type*: String  
*Maximum*: `2048`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`RiskRating`  <a name="cfn-sagemaker-modelcard-intendeduses-riskrating"></a>
Your organization's risk rating. You can specify one the following values as the risk rating:  
+ High
+ Medium
+ Low
+ Unknown
*Required*: No  
*Type*: String  
*Allowed values*: `High | Medium | Low | Unknown`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::SageMaker::ModelCard MetricDataItems
<a name="aws-properties-sagemaker-modelcard-metricdataitems"></a>

Metric data. The `type` determines the data types that you specify for `value`, `XAxisName` and `YAxisName`. For information about specifying values for metrics, see [model card JSON schema](https://docs.aws.amazon.com/sagemaker/latest/dg/model-cards.html#model-cards-json-schema).

## Syntax
<a name="aws-properties-sagemaker-modelcard-metricdataitems-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-sagemaker-modelcard-metricdataitems-syntax.json"></a>

```
{
  "[MetricDataItems](#cfn-sagemaker-modelcard-metricdataitems-metricdataitems)" : SimpleMetric
}
```

### YAML
<a name="aws-properties-sagemaker-modelcard-metricdataitems-syntax.yaml"></a>

```
  [MetricDataItems](#cfn-sagemaker-modelcard-metricdataitems-metricdataitems): 
    SimpleMetric
```

## Properties
<a name="aws-properties-sagemaker-modelcard-metricdataitems-properties"></a>

`MetricDataItems`  <a name="cfn-sagemaker-modelcard-metricdataitems-metricdataitems"></a>
A list of metric data items for the model.  
*Required*: No  
*Type*: [SimpleMetric](aws-properties-sagemaker-modelcard-simplemetric.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::SageMaker::ModelCard MetricGroup
<a name="aws-properties-sagemaker-modelcard-metricgroup"></a>

A group of metric data that you use to initialize a metric group object.

## Syntax
<a name="aws-properties-sagemaker-modelcard-metricgroup-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-sagemaker-modelcard-metricgroup-syntax.json"></a>

```
{
  "[MetricData](#cfn-sagemaker-modelcard-metricgroup-metricdata)" : [ MetricDataItems, ... ],
  "[Name](#cfn-sagemaker-modelcard-metricgroup-name)" : String
}
```

### YAML
<a name="aws-properties-sagemaker-modelcard-metricgroup-syntax.yaml"></a>

```
  [MetricData](#cfn-sagemaker-modelcard-metricgroup-metricdata): 
    - MetricDataItems
  [Name](#cfn-sagemaker-modelcard-metricgroup-name): String
```

## Properties
<a name="aws-properties-sagemaker-modelcard-metricgroup-properties"></a>

`MetricData`  <a name="cfn-sagemaker-modelcard-metricgroup-metricdata"></a>
A list of metric objects. The `MetricDataItems` list can have one of the following values:  
+  `bar_chart_metric` 
+  `matrix_metric` 
+  `simple_metric` 
+  `linear_graph_metric` 
For more information about the metric schema, see the definition section of the [model card JSON schema](https://docs.aws.amazon.com/sagemaker/latest/dg/model-cards.html#model-cards-json-schema).  
*Required*: Yes  
*Type*: Array of [MetricDataItems](aws-properties-sagemaker-modelcard-metricdataitems.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Name`  <a name="cfn-sagemaker-modelcard-metricgroup-name"></a>
The metric group name.  
*Required*: Yes  
*Type*: String  
*Pattern*: `.{1,63}`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::SageMaker::ModelCard ModelOverview
<a name="aws-properties-sagemaker-modelcard-modeloverview"></a>

An overview about the model.

## Syntax
<a name="aws-properties-sagemaker-modelcard-modeloverview-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-sagemaker-modelcard-modeloverview-syntax.json"></a>

```
{
  "[AlgorithmType](#cfn-sagemaker-modelcard-modeloverview-algorithmtype)" : String,
  "[InferenceEnvironment](#cfn-sagemaker-modelcard-modeloverview-inferenceenvironment)" : InferenceEnvironment,
  "[ModelArtifact](#cfn-sagemaker-modelcard-modeloverview-modelartifact)" : [ String, ... ],
  "[ModelCreator](#cfn-sagemaker-modelcard-modeloverview-modelcreator)" : String,
  "[ModelDescription](#cfn-sagemaker-modelcard-modeloverview-modeldescription)" : String,
  "[ModelId](#cfn-sagemaker-modelcard-modeloverview-modelid)" : String,
  "[ModelName](#cfn-sagemaker-modelcard-modeloverview-modelname)" : String,
  "[ModelOwner](#cfn-sagemaker-modelcard-modeloverview-modelowner)" : String,
  "[ModelVersion](#cfn-sagemaker-modelcard-modeloverview-modelversion)" : Number,
  "[ProblemType](#cfn-sagemaker-modelcard-modeloverview-problemtype)" : String
}
```

### YAML
<a name="aws-properties-sagemaker-modelcard-modeloverview-syntax.yaml"></a>

```
  [AlgorithmType](#cfn-sagemaker-modelcard-modeloverview-algorithmtype): String
  [InferenceEnvironment](#cfn-sagemaker-modelcard-modeloverview-inferenceenvironment): 
    InferenceEnvironment
  [ModelArtifact](#cfn-sagemaker-modelcard-modeloverview-modelartifact): 
    - String
  [ModelCreator](#cfn-sagemaker-modelcard-modeloverview-modelcreator): String
  [ModelDescription](#cfn-sagemaker-modelcard-modeloverview-modeldescription): String
  [ModelId](#cfn-sagemaker-modelcard-modeloverview-modelid): String
  [ModelName](#cfn-sagemaker-modelcard-modeloverview-modelname): String
  [ModelOwner](#cfn-sagemaker-modelcard-modeloverview-modelowner): String
  [ModelVersion](#cfn-sagemaker-modelcard-modeloverview-modelversion): Number
  [ProblemType](#cfn-sagemaker-modelcard-modeloverview-problemtype): String
```

## Properties
<a name="aws-properties-sagemaker-modelcard-modeloverview-properties"></a>

`AlgorithmType`  <a name="cfn-sagemaker-modelcard-modeloverview-algorithmtype"></a>
The algorithm used to solve the problem.  
*Required*: No  
*Type*: String  
*Maximum*: `1024`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`InferenceEnvironment`  <a name="cfn-sagemaker-modelcard-modeloverview-inferenceenvironment"></a>
An overview about model inference.  
*Required*: No  
*Type*: [InferenceEnvironment](aws-properties-sagemaker-modelcard-inferenceenvironment.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ModelArtifact`  <a name="cfn-sagemaker-modelcard-modeloverview-modelartifact"></a>
The location of the model artifact.  
*Required*: No  
*Type*: Array of String  
*Maximum*: `1024 | 15`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ModelCreator`  <a name="cfn-sagemaker-modelcard-modeloverview-modelcreator"></a>
The creator of the model.  
*Required*: No  
*Type*: String  
*Maximum*: `1024`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ModelDescription`  <a name="cfn-sagemaker-modelcard-modeloverview-modeldescription"></a>
A description of the model.  
*Required*: No  
*Type*: String  
*Maximum*: `1024`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ModelId`  <a name="cfn-sagemaker-modelcard-modeloverview-modelid"></a>
The SageMaker AI Model ARN or non-SageMaker AI Model ID.  
*Required*: No  
*Type*: String  
*Maximum*: `1024`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ModelName`  <a name="cfn-sagemaker-modelcard-modeloverview-modelname"></a>
The name of the model.  
*Required*: No  
*Type*: String  
*Maximum*: `1024`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ModelOwner`  <a name="cfn-sagemaker-modelcard-modeloverview-modelowner"></a>
The owner of the model.  
*Required*: No  
*Type*: String  
*Maximum*: `1024`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ModelVersion`  <a name="cfn-sagemaker-modelcard-modeloverview-modelversion"></a>
The version of the model.  
*Required*: No  
*Type*: Number  
*Minimum*: `1`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ProblemType`  <a name="cfn-sagemaker-modelcard-modeloverview-problemtype"></a>
The problem being solved with the model.  
*Required*: No  
*Type*: String  
*Maximum*: `1024`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::SageMaker::ModelCard ModelPackageCreator
<a name="aws-properties-sagemaker-modelcard-modelpackagecreator"></a>

Information about the user who created the model package.

## Syntax
<a name="aws-properties-sagemaker-modelcard-modelpackagecreator-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-sagemaker-modelcard-modelpackagecreator-syntax.json"></a>

```
{
  "[UserProfileName](#cfn-sagemaker-modelcard-modelpackagecreator-userprofilename)" : String
}
```

### YAML
<a name="aws-properties-sagemaker-modelcard-modelpackagecreator-syntax.yaml"></a>

```
  [UserProfileName](#cfn-sagemaker-modelcard-modelpackagecreator-userprofilename): String
```

## Properties
<a name="aws-properties-sagemaker-modelcard-modelpackagecreator-properties"></a>

`UserProfileName`  <a name="cfn-sagemaker-modelcard-modelpackagecreator-userprofilename"></a>
The user profile name of the model package creator.  
*Required*: No  
*Type*: String  
*Maximum*: `63`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::SageMaker::ModelCard ModelPackageDetails
<a name="aws-properties-sagemaker-modelcard-modelpackagedetails"></a>

Details about the model package associated with the model card.

## Syntax
<a name="aws-properties-sagemaker-modelcard-modelpackagedetails-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-sagemaker-modelcard-modelpackagedetails-syntax.json"></a>

```
{
  "[ApprovalDescription](#cfn-sagemaker-modelcard-modelpackagedetails-approvaldescription)" : String,
  "[CreatedBy](#cfn-sagemaker-modelcard-modelpackagedetails-createdby)" : ModelPackageCreator,
  "[Domain](#cfn-sagemaker-modelcard-modelpackagedetails-domain)" : String,
  "[InferenceSpecification](#cfn-sagemaker-modelcard-modelpackagedetails-inferencespecification)" : InferenceSpecification,
  "[ModelApprovalStatus](#cfn-sagemaker-modelcard-modelpackagedetails-modelapprovalstatus)" : String,
  "[ModelPackageArn](#cfn-sagemaker-modelcard-modelpackagedetails-modelpackagearn)" : String,
  "[ModelPackageDescription](#cfn-sagemaker-modelcard-modelpackagedetails-modelpackagedescription)" : String,
  "[ModelPackageGroupName](#cfn-sagemaker-modelcard-modelpackagedetails-modelpackagegroupname)" : String,
  "[ModelPackageName](#cfn-sagemaker-modelcard-modelpackagedetails-modelpackagename)" : String,
  "[ModelPackageStatus](#cfn-sagemaker-modelcard-modelpackagedetails-modelpackagestatus)" : String,
  "[ModelPackageVersion](#cfn-sagemaker-modelcard-modelpackagedetails-modelpackageversion)" : Number,
  "[SourceAlgorithms](#cfn-sagemaker-modelcard-modelpackagedetails-sourcealgorithms)" : [ SourceAlgorithm, ... ],
  "[Task](#cfn-sagemaker-modelcard-modelpackagedetails-task)" : String
}
```

### YAML
<a name="aws-properties-sagemaker-modelcard-modelpackagedetails-syntax.yaml"></a>

```
  [ApprovalDescription](#cfn-sagemaker-modelcard-modelpackagedetails-approvaldescription): String
  [CreatedBy](#cfn-sagemaker-modelcard-modelpackagedetails-createdby): 
    ModelPackageCreator
  [Domain](#cfn-sagemaker-modelcard-modelpackagedetails-domain): String
  [InferenceSpecification](#cfn-sagemaker-modelcard-modelpackagedetails-inferencespecification): 
    InferenceSpecification
  [ModelApprovalStatus](#cfn-sagemaker-modelcard-modelpackagedetails-modelapprovalstatus): String
  [ModelPackageArn](#cfn-sagemaker-modelcard-modelpackagedetails-modelpackagearn): String
  [ModelPackageDescription](#cfn-sagemaker-modelcard-modelpackagedetails-modelpackagedescription): String
  [ModelPackageGroupName](#cfn-sagemaker-modelcard-modelpackagedetails-modelpackagegroupname): String
  [ModelPackageName](#cfn-sagemaker-modelcard-modelpackagedetails-modelpackagename): String
  [ModelPackageStatus](#cfn-sagemaker-modelcard-modelpackagedetails-modelpackagestatus): String
  [ModelPackageVersion](#cfn-sagemaker-modelcard-modelpackagedetails-modelpackageversion): Number
  [SourceAlgorithms](#cfn-sagemaker-modelcard-modelpackagedetails-sourcealgorithms): 
    - SourceAlgorithm
  [Task](#cfn-sagemaker-modelcard-modelpackagedetails-task): String
```

## Properties
<a name="aws-properties-sagemaker-modelcard-modelpackagedetails-properties"></a>

`ApprovalDescription`  <a name="cfn-sagemaker-modelcard-modelpackagedetails-approvaldescription"></a>
A description of the approval status of the model package.  
*Required*: No  
*Type*: String  
*Maximum*: `1024`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`CreatedBy`  <a name="cfn-sagemaker-modelcard-modelpackagedetails-createdby"></a>
Information about the user who created the model package.  
*Required*: No  
*Type*: [ModelPackageCreator](aws-properties-sagemaker-modelcard-modelpackagecreator.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Domain`  <a name="cfn-sagemaker-modelcard-modelpackagedetails-domain"></a>
The machine learning domain of the model package.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`InferenceSpecification`  <a name="cfn-sagemaker-modelcard-modelpackagedetails-inferencespecification"></a>
Details about the inference specification for the model package.  
*Required*: No  
*Type*: [InferenceSpecification](aws-properties-sagemaker-modelcard-inferencespecification.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ModelApprovalStatus`  <a name="cfn-sagemaker-modelcard-modelpackagedetails-modelapprovalstatus"></a>
The approval status of the model package.  
*Required*: No  
*Type*: String  
*Allowed values*: `Approved | Rejected | PendingManualApproval`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ModelPackageArn`  <a name="cfn-sagemaker-modelcard-modelpackagedetails-modelpackagearn"></a>
The Amazon Resource Name (ARN) of the model package.  
*Required*: No  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `2048`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ModelPackageDescription`  <a name="cfn-sagemaker-modelcard-modelpackagedetails-modelpackagedescription"></a>
A description of the model package.  
*Required*: No  
*Type*: String  
*Maximum*: `1024`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ModelPackageGroupName`  <a name="cfn-sagemaker-modelcard-modelpackagedetails-modelpackagegroupname"></a>
The name of the model package group.  
*Required*: No  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `63`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ModelPackageName`  <a name="cfn-sagemaker-modelcard-modelpackagedetails-modelpackagename"></a>
The name of the model package.  
*Required*: No  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `63`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ModelPackageStatus`  <a name="cfn-sagemaker-modelcard-modelpackagedetails-modelpackagestatus"></a>
The status of the model package.  
*Required*: No  
*Type*: String  
*Allowed values*: `Pending | InProgress | Completed | Failed | Deleting`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ModelPackageVersion`  <a name="cfn-sagemaker-modelcard-modelpackagedetails-modelpackageversion"></a>
The version of the model package.  
*Required*: No  
*Type*: Number  
*Minimum*: `1`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`SourceAlgorithms`  <a name="cfn-sagemaker-modelcard-modelpackagedetails-sourcealgorithms"></a>
A list of algorithms that were used to create the model package.  
*Required*: No  
*Type*: Array of [SourceAlgorithm](aws-properties-sagemaker-modelcard-sourcealgorithm.md)  
*Minimum*: `1`  
*Maximum*: `1`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Task`  <a name="cfn-sagemaker-modelcard-modelpackagedetails-task"></a>
The machine learning task performed by the model package.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::SageMaker::ModelCard ObjectiveFunction
<a name="aws-properties-sagemaker-modelcard-objectivefunction"></a>

The function that is optimized during model training.

## Syntax
<a name="aws-properties-sagemaker-modelcard-objectivefunction-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-sagemaker-modelcard-objectivefunction-syntax.json"></a>

```
{
  "[Function](#cfn-sagemaker-modelcard-objectivefunction-function)" : Function,
  "[Notes](#cfn-sagemaker-modelcard-objectivefunction-notes)" : String
}
```

### YAML
<a name="aws-properties-sagemaker-modelcard-objectivefunction-syntax.yaml"></a>

```
  [Function](#cfn-sagemaker-modelcard-objectivefunction-function): 
    Function
  [Notes](#cfn-sagemaker-modelcard-objectivefunction-notes): String
```

## Properties
<a name="aws-properties-sagemaker-modelcard-objectivefunction-properties"></a>

`Function`  <a name="cfn-sagemaker-modelcard-objectivefunction-function"></a>
A function object that details optimization direction, metric, and additional descriptions.  
*Required*: No  
*Type*: [Function](aws-properties-sagemaker-modelcard-function.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Notes`  <a name="cfn-sagemaker-modelcard-objectivefunction-notes"></a>
Notes about the object function, including other considerations for possible objective functions.  
*Required*: No  
*Type*: String  
*Maximum*: `1024`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::SageMaker::ModelCard SecurityConfig
<a name="aws-properties-sagemaker-modelcard-securityconfig"></a>

The security configuration used to protect model card data.

## Syntax
<a name="aws-properties-sagemaker-modelcard-securityconfig-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-sagemaker-modelcard-securityconfig-syntax.json"></a>

```
{
  "[KmsKeyId](#cfn-sagemaker-modelcard-securityconfig-kmskeyid)" : String
}
```

### YAML
<a name="aws-properties-sagemaker-modelcard-securityconfig-syntax.yaml"></a>

```
  [KmsKeyId](#cfn-sagemaker-modelcard-securityconfig-kmskeyid): String
```

## Properties
<a name="aws-properties-sagemaker-modelcard-securityconfig-properties"></a>

`KmsKeyId`  <a name="cfn-sagemaker-modelcard-securityconfig-kmskeyid"></a>
A AWS Key Management Service[key ID](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-id) used to encrypt a model card.  
*Required*: No  
*Type*: String  
*Pattern*: `.*`  
*Maximum*: `2048`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

# AWS::SageMaker::ModelCard SimpleMetric
<a name="aws-properties-sagemaker-modelcard-simplemetric"></a>

A simple metric for evaluating model performance.

## Syntax
<a name="aws-properties-sagemaker-modelcard-simplemetric-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-sagemaker-modelcard-simplemetric-syntax.json"></a>

```
{
  "[Name](#cfn-sagemaker-modelcard-simplemetric-name)" : String,
  "[Notes](#cfn-sagemaker-modelcard-simplemetric-notes)" : String,
  "[Type](#cfn-sagemaker-modelcard-simplemetric-type)" : String,
  "[Value](#cfn-sagemaker-modelcard-simplemetric-value)" : Number,
  "[XAxisName](#cfn-sagemaker-modelcard-simplemetric-xaxisname)" : String,
  "[YAxisName](#cfn-sagemaker-modelcard-simplemetric-yaxisname)" : String
}
```

### YAML
<a name="aws-properties-sagemaker-modelcard-simplemetric-syntax.yaml"></a>

```
  [Name](#cfn-sagemaker-modelcard-simplemetric-name): String
  [Notes](#cfn-sagemaker-modelcard-simplemetric-notes): String
  [Type](#cfn-sagemaker-modelcard-simplemetric-type): String
  [Value](#cfn-sagemaker-modelcard-simplemetric-value): Number
  [XAxisName](#cfn-sagemaker-modelcard-simplemetric-xaxisname): String
  [YAxisName](#cfn-sagemaker-modelcard-simplemetric-yaxisname): String
```

## Properties
<a name="aws-properties-sagemaker-modelcard-simplemetric-properties"></a>

`Name`  <a name="cfn-sagemaker-modelcard-simplemetric-name"></a>
The name of the metric.  
*Required*: Yes  
*Type*: String  
*Pattern*: `.{1,255}`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Notes`  <a name="cfn-sagemaker-modelcard-simplemetric-notes"></a>
Additional notes about the metric.  
*Required*: No  
*Type*: String  
*Maximum*: `1024`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Type`  <a name="cfn-sagemaker-modelcard-simplemetric-type"></a>
The type of the metric.  
*Required*: Yes  
*Type*: String  
*Allowed values*: `number | string | boolean`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Value`  <a name="cfn-sagemaker-modelcard-simplemetric-value"></a>
The value of the metric.  
*Required*: Yes  
*Type*: Number  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`XAxisName`  <a name="cfn-sagemaker-modelcard-simplemetric-xaxisname"></a>
The name of the X-axis for the metric visualization.  
*Required*: No  
*Type*: String  
*Maximum*: `63`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`YAxisName`  <a name="cfn-sagemaker-modelcard-simplemetric-yaxisname"></a>
The name of the Y-axis for the metric visualization.  
*Required*: No  
*Type*: String  
*Maximum*: `63`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::SageMaker::ModelCard SourceAlgorithm
<a name="aws-properties-sagemaker-modelcard-sourcealgorithm"></a>

Specifies an algorithm that was used to create the model package. The algorithm must be either an algorithm resource in your SageMaker account or an algorithm in AWS Marketplace that you are subscribed to.

## Syntax
<a name="aws-properties-sagemaker-modelcard-sourcealgorithm-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-sagemaker-modelcard-sourcealgorithm-syntax.json"></a>

```
{
  "[AlgorithmName](#cfn-sagemaker-modelcard-sourcealgorithm-algorithmname)" : String,
  "[ModelDataUrl](#cfn-sagemaker-modelcard-sourcealgorithm-modeldataurl)" : String
}
```

### YAML
<a name="aws-properties-sagemaker-modelcard-sourcealgorithm-syntax.yaml"></a>

```
  [AlgorithmName](#cfn-sagemaker-modelcard-sourcealgorithm-algorithmname): String
  [ModelDataUrl](#cfn-sagemaker-modelcard-sourcealgorithm-modeldataurl): String
```

## Properties
<a name="aws-properties-sagemaker-modelcard-sourcealgorithm-properties"></a>

`AlgorithmName`  <a name="cfn-sagemaker-modelcard-sourcealgorithm-algorithmname"></a>
The name of an algorithm that was used to create the model package. The algorithm must be either an algorithm resource in your SageMaker account or an algorithm in AWS Marketplace that you are subscribed to.  
*Required*: Yes  
*Type*: String  
*Maximum*: `170`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ModelDataUrl`  <a name="cfn-sagemaker-modelcard-sourcealgorithm-modeldataurl"></a>
The Amazon S3 path where the model artifacts, which result from model training, are stored. This path must point to a single `gzip` compressed tar archive (`.tar.gz` suffix).  
The model artifacts must be in an S3 bucket that is in the same AWS region as the algorithm.
*Required*: No  
*Type*: String  
*Maximum*: `1024`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::SageMaker::ModelCard Tag
<a name="aws-properties-sagemaker-modelcard-tag"></a>

A tag object that consists of a key and an optional value, used to manage metadata for SageMaker AWS resources.

You can add tags to notebook instances, training jobs, hyperparameter tuning jobs, batch transform jobs, models, labeling jobs, work teams, endpoint configurations, and endpoints. For more information on adding tags to SageMaker resources, see [AddTags](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_AddTags.html).

For more information on adding metadata to your AWS resources with tagging, see [Tagging AWS resources](https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html). For advice on best practices for managing AWS resources with tagging, see [Tagging Best Practices: Implement an Effective AWS Resource Tagging Strategy](https://d1.awsstatic.com/whitepapers/aws-tagging-best-practices.pdf).

## Syntax
<a name="aws-properties-sagemaker-modelcard-tag-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-sagemaker-modelcard-tag-syntax.json"></a>

```
{
  "[Key](#cfn-sagemaker-modelcard-tag-key)" : String,
  "[Value](#cfn-sagemaker-modelcard-tag-value)" : String
}
```

### YAML
<a name="aws-properties-sagemaker-modelcard-tag-syntax.yaml"></a>

```
  [Key](#cfn-sagemaker-modelcard-tag-key): String
  [Value](#cfn-sagemaker-modelcard-tag-value): String
```

## Properties
<a name="aws-properties-sagemaker-modelcard-tag-properties"></a>

`Key`  <a name="cfn-sagemaker-modelcard-tag-key"></a>
The tag key. Tag keys must be unique per resource.  
*Required*: Yes  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `128`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Value`  <a name="cfn-sagemaker-modelcard-tag-value"></a>
The tag value.  
*Required*: Yes  
*Type*: String  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::SageMaker::ModelCard TrainingDetails
<a name="aws-properties-sagemaker-modelcard-trainingdetails"></a>

The training details of the model

## Syntax
<a name="aws-properties-sagemaker-modelcard-trainingdetails-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-sagemaker-modelcard-trainingdetails-syntax.json"></a>

```
{
  "[ObjectiveFunction](#cfn-sagemaker-modelcard-trainingdetails-objectivefunction)" : ObjectiveFunction,
  "[TrainingJobDetails](#cfn-sagemaker-modelcard-trainingdetails-trainingjobdetails)" : TrainingJobDetails,
  "[TrainingObservations](#cfn-sagemaker-modelcard-trainingdetails-trainingobservations)" : String
}
```

### YAML
<a name="aws-properties-sagemaker-modelcard-trainingdetails-syntax.yaml"></a>

```
  [ObjectiveFunction](#cfn-sagemaker-modelcard-trainingdetails-objectivefunction): 
    ObjectiveFunction
  [TrainingJobDetails](#cfn-sagemaker-modelcard-trainingdetails-trainingjobdetails): 
    TrainingJobDetails
  [TrainingObservations](#cfn-sagemaker-modelcard-trainingdetails-trainingobservations): String
```

## Properties
<a name="aws-properties-sagemaker-modelcard-trainingdetails-properties"></a>

`ObjectiveFunction`  <a name="cfn-sagemaker-modelcard-trainingdetails-objectivefunction"></a>
The function that is optimized during model training.  
*Required*: No  
*Type*: [ObjectiveFunction](aws-properties-sagemaker-modelcard-objectivefunction.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`TrainingJobDetails`  <a name="cfn-sagemaker-modelcard-trainingdetails-trainingjobdetails"></a>
Details about any associated training jobs.  
*Required*: No  
*Type*: [TrainingJobDetails](aws-properties-sagemaker-modelcard-trainingjobdetails.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`TrainingObservations`  <a name="cfn-sagemaker-modelcard-trainingdetails-trainingobservations"></a>
Any observations about training.  
*Required*: No  
*Type*: String  
*Maximum*: `1024`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::SageMaker::ModelCard TrainingEnvironment
<a name="aws-properties-sagemaker-modelcard-trainingenvironment"></a>

SageMaker AI training image.

## Syntax
<a name="aws-properties-sagemaker-modelcard-trainingenvironment-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-sagemaker-modelcard-trainingenvironment-syntax.json"></a>

```
{
  "[ContainerImage](#cfn-sagemaker-modelcard-trainingenvironment-containerimage)" : [ String, ... ]
}
```

### YAML
<a name="aws-properties-sagemaker-modelcard-trainingenvironment-syntax.yaml"></a>

```
  [ContainerImage](#cfn-sagemaker-modelcard-trainingenvironment-containerimage): 
    - String
```

## Properties
<a name="aws-properties-sagemaker-modelcard-trainingenvironment-properties"></a>

`ContainerImage`  <a name="cfn-sagemaker-modelcard-trainingenvironment-containerimage"></a>
SageMaker AI inference image URI.  
*Required*: No  
*Type*: Array of String  
*Maximum*: `1024 | 15`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::SageMaker::ModelCard TrainingHyperParameter
<a name="aws-properties-sagemaker-modelcard-traininghyperparameter"></a>

A hyper parameter that was configured in training the model.

## Syntax
<a name="aws-properties-sagemaker-modelcard-traininghyperparameter-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-sagemaker-modelcard-traininghyperparameter-syntax.json"></a>

```
{
  "[Name](#cfn-sagemaker-modelcard-traininghyperparameter-name)" : String,
  "[Value](#cfn-sagemaker-modelcard-traininghyperparameter-value)" : String
}
```

### YAML
<a name="aws-properties-sagemaker-modelcard-traininghyperparameter-syntax.yaml"></a>

```
  [Name](#cfn-sagemaker-modelcard-traininghyperparameter-name): String
  [Value](#cfn-sagemaker-modelcard-traininghyperparameter-value): String
```

## Properties
<a name="aws-properties-sagemaker-modelcard-traininghyperparameter-properties"></a>

`Name`  <a name="cfn-sagemaker-modelcard-traininghyperparameter-name"></a>
The name of the hyper parameter.  
*Required*: Yes  
*Type*: String  
*Pattern*: `.{1,255}`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Value`  <a name="cfn-sagemaker-modelcard-traininghyperparameter-value"></a>
The value specified for the hyper parameter.  
*Required*: Yes  
*Type*: String  
*Pattern*: `.{1,255}`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::SageMaker::ModelCard TrainingJobDetails
<a name="aws-properties-sagemaker-modelcard-trainingjobdetails"></a>

The overview of a training job.

## Syntax
<a name="aws-properties-sagemaker-modelcard-trainingjobdetails-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-sagemaker-modelcard-trainingjobdetails-syntax.json"></a>

```
{
  "[HyperParameters](#cfn-sagemaker-modelcard-trainingjobdetails-hyperparameters)" : [ TrainingHyperParameter, ... ],
  "[TrainingArn](#cfn-sagemaker-modelcard-trainingjobdetails-trainingarn)" : String,
  "[TrainingDatasets](#cfn-sagemaker-modelcard-trainingjobdetails-trainingdatasets)" : [ String, ... ],
  "[TrainingEnvironment](#cfn-sagemaker-modelcard-trainingjobdetails-trainingenvironment)" : TrainingEnvironment,
  "[TrainingMetrics](#cfn-sagemaker-modelcard-trainingjobdetails-trainingmetrics)" : [ TrainingMetric, ... ],
  "[UserProvidedHyperParameters](#cfn-sagemaker-modelcard-trainingjobdetails-userprovidedhyperparameters)" : [ TrainingHyperParameter, ... ],
  "[UserProvidedTrainingMetrics](#cfn-sagemaker-modelcard-trainingjobdetails-userprovidedtrainingmetrics)" : [ TrainingMetric, ... ]
}
```

### YAML
<a name="aws-properties-sagemaker-modelcard-trainingjobdetails-syntax.yaml"></a>

```
  [HyperParameters](#cfn-sagemaker-modelcard-trainingjobdetails-hyperparameters): 
    - TrainingHyperParameter
  [TrainingArn](#cfn-sagemaker-modelcard-trainingjobdetails-trainingarn): String
  [TrainingDatasets](#cfn-sagemaker-modelcard-trainingjobdetails-trainingdatasets): 
    - String
  [TrainingEnvironment](#cfn-sagemaker-modelcard-trainingjobdetails-trainingenvironment): 
    TrainingEnvironment
  [TrainingMetrics](#cfn-sagemaker-modelcard-trainingjobdetails-trainingmetrics): 
    - TrainingMetric
  [UserProvidedHyperParameters](#cfn-sagemaker-modelcard-trainingjobdetails-userprovidedhyperparameters): 
    - TrainingHyperParameter
  [UserProvidedTrainingMetrics](#cfn-sagemaker-modelcard-trainingjobdetails-userprovidedtrainingmetrics): 
    - TrainingMetric
```

## Properties
<a name="aws-properties-sagemaker-modelcard-trainingjobdetails-properties"></a>

`HyperParameters`  <a name="cfn-sagemaker-modelcard-trainingjobdetails-hyperparameters"></a>
The hyper parameters used in the training job.  
*Required*: No  
*Type*: Array of [TrainingHyperParameter](aws-properties-sagemaker-modelcard-traininghyperparameter.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`TrainingArn`  <a name="cfn-sagemaker-modelcard-trainingjobdetails-trainingarn"></a>
The SageMaker AI training job Amazon Resource Name (ARN)  
*Required*: No  
*Type*: String  
*Maximum*: `1024`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`TrainingDatasets`  <a name="cfn-sagemaker-modelcard-trainingjobdetails-trainingdatasets"></a>
The location of the datasets used to train the model.  
*Required*: No  
*Type*: Array of String  
*Maximum*: `1024 | 15`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`TrainingEnvironment`  <a name="cfn-sagemaker-modelcard-trainingjobdetails-trainingenvironment"></a>
The SageMaker AI training job image URI.  
*Required*: No  
*Type*: [TrainingEnvironment](aws-properties-sagemaker-modelcard-trainingenvironment.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`TrainingMetrics`  <a name="cfn-sagemaker-modelcard-trainingjobdetails-trainingmetrics"></a>
The SageMaker AI training job results.  
*Required*: No  
*Type*: Array of [TrainingMetric](aws-properties-sagemaker-modelcard-trainingmetric.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`UserProvidedHyperParameters`  <a name="cfn-sagemaker-modelcard-trainingjobdetails-userprovidedhyperparameters"></a>
Additional hyper parameters that you've specified when training the model.  
*Required*: No  
*Type*: Array of [TrainingHyperParameter](aws-properties-sagemaker-modelcard-traininghyperparameter.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`UserProvidedTrainingMetrics`  <a name="cfn-sagemaker-modelcard-trainingjobdetails-userprovidedtrainingmetrics"></a>
Custom training job results.  
*Required*: No  
*Type*: Array of [TrainingMetric](aws-properties-sagemaker-modelcard-trainingmetric.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::SageMaker::ModelCard TrainingMetric
<a name="aws-properties-sagemaker-modelcard-trainingmetric"></a>

A result from a SageMaker AI training job.

## Syntax
<a name="aws-properties-sagemaker-modelcard-trainingmetric-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-sagemaker-modelcard-trainingmetric-syntax.json"></a>

```
{
  "[Name](#cfn-sagemaker-modelcard-trainingmetric-name)" : String,
  "[Notes](#cfn-sagemaker-modelcard-trainingmetric-notes)" : String,
  "[Value](#cfn-sagemaker-modelcard-trainingmetric-value)" : Number
}
```

### YAML
<a name="aws-properties-sagemaker-modelcard-trainingmetric-syntax.yaml"></a>

```
  [Name](#cfn-sagemaker-modelcard-trainingmetric-name): String
  [Notes](#cfn-sagemaker-modelcard-trainingmetric-notes): String
  [Value](#cfn-sagemaker-modelcard-trainingmetric-value): Number
```

## Properties
<a name="aws-properties-sagemaker-modelcard-trainingmetric-properties"></a>

`Name`  <a name="cfn-sagemaker-modelcard-trainingmetric-name"></a>
The name of the result from the SageMaker AI training job.  
*Required*: Yes  
*Type*: String  
*Pattern*: `.{1,255}`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Notes`  <a name="cfn-sagemaker-modelcard-trainingmetric-notes"></a>
Any additional notes describing the result of the training job.  
*Required*: No  
*Type*: String  
*Maximum*: `1024`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Value`  <a name="cfn-sagemaker-modelcard-trainingmetric-value"></a>
The value of a result from the SageMaker AI training job.  
*Required*: Yes  
*Type*: Number  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::SageMaker::ModelCard UserContext
<a name="aws-properties-sagemaker-modelcard-usercontext"></a>

Information about the user who created or modified a SageMaker resource.

## Syntax
<a name="aws-properties-sagemaker-modelcard-usercontext-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-sagemaker-modelcard-usercontext-syntax.json"></a>

```
{
  "[DomainId](#cfn-sagemaker-modelcard-usercontext-domainid)" : String,
  "[UserProfileArn](#cfn-sagemaker-modelcard-usercontext-userprofilearn)" : String,
  "[UserProfileName](#cfn-sagemaker-modelcard-usercontext-userprofilename)" : String
}
```

### YAML
<a name="aws-properties-sagemaker-modelcard-usercontext-syntax.yaml"></a>

```
  [DomainId](#cfn-sagemaker-modelcard-usercontext-domainid): String
  [UserProfileArn](#cfn-sagemaker-modelcard-usercontext-userprofilearn): String
  [UserProfileName](#cfn-sagemaker-modelcard-usercontext-userprofilename): String
```

## Properties
<a name="aws-properties-sagemaker-modelcard-usercontext-properties"></a>

`DomainId`  <a name="cfn-sagemaker-modelcard-usercontext-domainid"></a>
The domain associated with the user.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`UserProfileArn`  <a name="cfn-sagemaker-modelcard-usercontext-userprofilearn"></a>
The Amazon Resource Name (ARN) of the user's profile.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`UserProfileName`  <a name="cfn-sagemaker-modelcard-usercontext-userprofilename"></a>
The name of the user's profile.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)