@propulsionworks/cloudformation 0.1.0 → 0.1.2

package/out/exports/resources.generated/aws-sagemaker-modelcard.d.ts

@@ -1,23 +1,33 @@
 import type { ResourceDefinitionWithAttributes, Tag } from "../main.ts";
+/**
+ * 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) .
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelcard.html}
+ */
 export type SageMakerModelCard = ResourceDefinitionWithAttributes<"AWS::SageMaker::ModelCard", SageMakerModelCardProps, SageMakerModelCardAttribs>;
 /**
  * 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) .
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelcard.html}
  */
 export type SageMakerModelCardProps = {
     /**
      * 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) .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelcard.html#cfn-sagemaker-modelcard-content}
      */
     Content: Content;
     /**
      * Information about the user who created or modified an experiment, trial, trial component, lineage group, project, or model card.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelcard.html#cfn-sagemaker-modelcard-lastmodifiedby}
      */
     LastModifiedBy?: UserContext | undefined;
     /**
      * The unique name of the model card.
      * @maxLength 63
      * @pattern ^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelcard.html#cfn-sagemaker-modelcard-modelcardname}
      */
     ModelCardName: string;
     /**
@@ -27,54 +37,68 @@ export type SageMakerModelCardProps = {
      * - `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.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelcard.html#cfn-sagemaker-modelcard-modelcardstatus}
      */
     ModelCardStatus: "Draft" | "PendingReview" | "Approved" | "Archived";
     /**
      * The security configuration used to protect model card data.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelcard.html#cfn-sagemaker-modelcard-securityconfig}
      */
     SecurityConfig?: SecurityConfig | undefined;
     /**
      * Key-value pairs used to manage metadata for the model card.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelcard.html#cfn-sagemaker-modelcard-tags}
      */
     Tags?: Tag[] | undefined;
 };
+/**
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelcard.html#aws-resource-sagemaker-modelcard-return-values}
+ */
 export type SageMakerModelCardAttribs = {
     /**
      * The domain associated with the user.
      * @default "UnsetValue"
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-usercontext.html#cfn-sagemaker-modelcard-usercontext-domainid}
      */
     "CreatedBy.DomainId": string;
     /**
      * The Amazon Resource Name (ARN) of the user's profile.
      * @default "UnsetValue"
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-usercontext.html#cfn-sagemaker-modelcard-usercontext-userprofilearn}
      */
     "CreatedBy.UserProfileArn": string;
     /**
      * The name of the user's profile.
      * @default "UnsetValue"
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-usercontext.html#cfn-sagemaker-modelcard-usercontext-userprofilename}
      */
     "CreatedBy.UserProfileName": string;
     /**
      * The date and time the model card was created.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelcard.html#cfn-sagemaker-modelcard-creationtime}
      */
     CreationTime: string;
     /**
      * The domain associated with the user.
      * @default "UnsetValue"
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-usercontext.html#cfn-sagemaker-modelcard-usercontext-domainid}
      */
     "LastModifiedBy.DomainId": string;
     /**
      * The Amazon Resource Name (ARN) of the user's profile.
      * @default "UnsetValue"
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-usercontext.html#cfn-sagemaker-modelcard-usercontext-userprofilearn}
      */
     "LastModifiedBy.UserProfileArn": string;
     /**
      * The name of the user's profile.
      * @default "UnsetValue"
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-usercontext.html#cfn-sagemaker-modelcard-usercontext-userprofilename}
      */
     "LastModifiedBy.UserProfileName": string;
     /**
      * The date and time the model card was last modified.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelcard.html#cfn-sagemaker-modelcard-lastmodifiedtime}
      */
     LastModifiedTime: string;
     /**
@@ -82,185 +106,241 @@ export type SageMakerModelCardAttribs = {
      * @minLength 1
      * @maxLength 256
      * @pattern ^arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]{9,16}:[0-9]{12}:model-card/[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelcard.html#cfn-sagemaker-modelcard-modelcardarn}
      */
     ModelCardArn: string;
     /**
      * The processing status of model card deletion. The ModelCardProcessingStatus updates throughout the different deletion steps.
      * @default "UnsetValue"
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelcard.html#cfn-sagemaker-modelcard-modelcardprocessingstatus}
      */
     ModelCardProcessingStatus: "UnsetValue" | "DeleteInProgress" | "DeletePending" | "ContentDeleted" | "ExportJobsDeleted" | "DeleteCompleted" | "DeleteFailed";
     /**
      * A version of the model card.
      * @min 1
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelcard.html#cfn-sagemaker-modelcard-modelcardversion}
      */
     ModelCardVersion: number;
 };
 /**
  * Additional information about the model.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-additionalinformation.html}
  */
 export type AdditionalInformation = {
     /**
      * Caveats and recommendations for those who might use this model in their applications.
      * @maxLength 2048
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-additionalinformation.html#cfn-sagemaker-modelcard-additionalinformation-caveatsandrecommendations}
      */
     CaveatsAndRecommendations?: string | undefined;
     /**
      * Any additional information to document about the model.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-additionalinformation.html#cfn-sagemaker-modelcard-additionalinformation-customdetails}
      */
     CustomDetails?: Record<string, string> | undefined;
     /**
      * Any ethical considerations documented by the model card author.
      * @maxLength 2048
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-additionalinformation.html#cfn-sagemaker-modelcard-additionalinformation-ethicalconsiderations}
      */
     EthicalConsiderations?: string | undefined;
 };
+/**
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-barchartmetric.html}
+ */
 export type BarChartMetric = {
     /**
      * @pattern .{1,255}
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-barchartmetric.html#cfn-sagemaker-modelcard-barchartmetric-name}
      */
     Name: string;
     /**
      * @maxLength 1024
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-barchartmetric.html#cfn-sagemaker-modelcard-barchartmetric-notes}
      */
     Notes?: string | undefined;
+    /**
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-barchartmetric.html#cfn-sagemaker-modelcard-barchartmetric-type}
+     */
     Type: "bar_chart";
+    /**
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-barchartmetric.html#cfn-sagemaker-modelcard-barchartmetric-value}
+     */
     Value: number[];
+    /**
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-barchartmetric.html#cfn-sagemaker-modelcard-barchartmetric-xaxisname}
+     */
     XAxisName?: string[] | undefined;
+    /**
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-barchartmetric.html#cfn-sagemaker-modelcard-barchartmetric-yaxisname}
+     */
     YAxisName?: string | undefined;
 };
 /**
  * Information about how the model supports business goals.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-businessdetails.html}
  */
 export type BusinessDetails = {
     /**
      * The specific business problem that the model is trying to solve.
      * @maxLength 2048
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-businessdetails.html#cfn-sagemaker-modelcard-businessdetails-businessproblem}
      */
     BusinessProblem?: string | undefined;
     /**
      * The relevant stakeholders for the model.
      * @maxLength 2048
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-businessdetails.html#cfn-sagemaker-modelcard-businessdetails-businessstakeholders}
      */
     BusinessStakeholders?: string | undefined;
     /**
      * The broader business need that the model is serving.
      * @maxLength 2048
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-businessdetails.html#cfn-sagemaker-modelcard-businessdetails-lineofbusiness}
      */
     LineOfBusiness?: string | undefined;
 };
+/**
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-container.html}
+ */
 export type Container = {
     /**
      * Inference environment path. The Amazon EC2 Container Registry (Amazon ECR) path where inference code is stored.
      * @maxLength 255
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-container.html#cfn-sagemaker-modelcard-container-image}
      */
     Image: string;
     /**
      * The Amazon S3 path where the model artifacts, which result from model training, are stored.
      * @maxLength 1024
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-container.html#cfn-sagemaker-modelcard-container-modeldataurl}
      */
     ModelDataUrl?: string | undefined;
     /**
      * The name of a pre-trained machine learning benchmarked by Amazon SageMaker Inference Recommender model that matches your model.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-container.html#cfn-sagemaker-modelcard-container-nearestmodelname}
      */
     NearestModelName?: string | undefined;
 };
 /**
  * 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) .
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-content.html}
  */
 export type Content = {
     /**
      * Additional information about the model.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-content.html#cfn-sagemaker-modelcard-content-additionalinformation}
      */
     AdditionalInformation?: AdditionalInformation | undefined;
     /**
      * Information about how the model supports business goals.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-content.html#cfn-sagemaker-modelcard-content-businessdetails}
      */
     BusinessDetails?: BusinessDetails | undefined;
     /**
      * An overview about the model's evaluation.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-content.html#cfn-sagemaker-modelcard-content-evaluationdetails}
      */
     EvaluationDetails?: EvaluationDetail[] | undefined;
     /**
      * The intended usage of the model.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-content.html#cfn-sagemaker-modelcard-content-intendeduses}
      */
     IntendedUses?: IntendedUses | undefined;
     /**
      * An overview about the model
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-content.html#cfn-sagemaker-modelcard-content-modeloverview}
      */
     ModelOverview?: ModelOverview | undefined;
     /**
      * Metadata information related to model package version
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-content.html#cfn-sagemaker-modelcard-content-modelpackagedetails}
      */
     ModelPackageDetails?: ModelPackageDetails | undefined;
     /**
      * An overview about model training.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-content.html#cfn-sagemaker-modelcard-content-trainingdetails}
      */
     TrainingDetails?: TrainingDetails | undefined;
 };
 /**
  * The evaluation details of the model.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-evaluationdetail.html}
  */
 export type EvaluationDetail = {
     /**
      * The location of the datasets used to evaluate the model.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-evaluationdetail.html#cfn-sagemaker-modelcard-evaluationdetail-datasets}
      */
     Datasets?: string[] | undefined;
     /**
      * The Amazon Resource Name (ARN) of the evaluation job.
      * @maxLength 256
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-evaluationdetail.html#cfn-sagemaker-modelcard-evaluationdetail-evaluationjobarn}
      */
     EvaluationJobArn?: string | undefined;
     /**
      * Any observations made during the model evaluation.
      * @maxLength 2096
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-evaluationdetail.html#cfn-sagemaker-modelcard-evaluationdetail-evaluationobservation}
      */
     EvaluationObservation?: string | undefined;
     /**
      * Additional attributes associated with the evaluation results.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-evaluationdetail.html#cfn-sagemaker-modelcard-evaluationdetail-metadata}
      */
     Metadata?: Record<string, string> | undefined;
     /**
      * An evaluation Metric Group object.
      * @default []
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-evaluationdetail.html#cfn-sagemaker-modelcard-evaluationdetail-metricgroups}
      */
     MetricGroups?: MetricGroup[] | undefined;
     /**
      * The evaluation job name.
      * @pattern .{1,63}
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-evaluationdetail.html#cfn-sagemaker-modelcard-evaluationdetail-name}
      */
     Name: string;
 };
 /**
  * Defines how to perform inference generation after a training job is run.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-inferencespecification.html}
  */
 export type InferenceSpecification = {
     /**
      * The Amazon ECR registry path of the Docker image that contains the inference code.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-inferencespecification.html#cfn-sagemaker-modelcard-inferencespecification-containers}
      */
     Containers: Container[];
 };
 /**
  * The intended uses of a model.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-intendeduses.html}
  */
 export type IntendedUses = {
     /**
      * An explanation of why your organization categorizes the model with its risk rating.
      * @maxLength 2048
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-intendeduses.html#cfn-sagemaker-modelcard-intendeduses-explanationsforriskrating}
      */
     ExplanationsForRiskRating?: string | undefined;
     /**
      * Factors affecting model efficacy.
      * @maxLength 2048
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-intendeduses.html#cfn-sagemaker-modelcard-intendeduses-factorsaffectingmodelefficiency}
      */
     FactorsAffectingModelEfficiency?: string | undefined;
     /**
      * The intended use cases for the model.
      * @maxLength 2048
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-intendeduses.html#cfn-sagemaker-modelcard-intendeduses-intendeduses}
      */
     IntendedUses?: string | undefined;
     /**
      * The general purpose of the model.
      * @maxLength 2048
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-intendeduses.html#cfn-sagemaker-modelcard-intendeduses-purposeofmodel}
      */
     PurposeOfModel?: string | undefined;
     /**
@@ -270,42 +350,76 @@ export type IntendedUses = {
      * - Medium
      * - Low
      * - Unknown
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-intendeduses.html#cfn-sagemaker-modelcard-intendeduses-riskrating}
      */
     RiskRating?: RiskRating | undefined;
 };
 /**
  * Linear graph metric.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-lineargraphmetric.html}
  */
 export type LinearGraphMetric = {
     /**
      * @pattern .{1,255}
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-lineargraphmetric.html#cfn-sagemaker-modelcard-lineargraphmetric-name}
      */
     Name: string;
     /**
      * @maxLength 1024
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-lineargraphmetric.html#cfn-sagemaker-modelcard-lineargraphmetric-notes}
      */
     Notes?: string | undefined;
+    /**
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-lineargraphmetric.html#cfn-sagemaker-modelcard-lineargraphmetric-type}
+     */
     Type: "linear_graph";
+    /**
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-lineargraphmetric.html#cfn-sagemaker-modelcard-lineargraphmetric-value}
+     */
     Value: number[][];
+    /**
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-lineargraphmetric.html#cfn-sagemaker-modelcard-lineargraphmetric-xaxisname}
+     */
     XAxisName?: string | undefined;
+    /**
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-lineargraphmetric.html#cfn-sagemaker-modelcard-lineargraphmetric-yaxisname}
+     */
     YAxisName?: string | undefined;
 };
+/**
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-matrixmetric.html}
+ */
 export type MatrixMetric = {
     /**
      * @pattern .{1,255}
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-matrixmetric.html#cfn-sagemaker-modelcard-matrixmetric-name}
      */
     Name: string;
     /**
      * @maxLength 1024
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-matrixmetric.html#cfn-sagemaker-modelcard-matrixmetric-notes}
      */
     Notes?: string | undefined;
+    /**
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-matrixmetric.html#cfn-sagemaker-modelcard-matrixmetric-type}
+     */
     Type: "matrix";
+    /**
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-matrixmetric.html#cfn-sagemaker-modelcard-matrixmetric-value}
+     */
     Value: number[][];
+    /**
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-matrixmetric.html#cfn-sagemaker-modelcard-matrixmetric-xaxisname}
+     */
     XAxisName?: string[] | undefined;
+    /**
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-matrixmetric.html#cfn-sagemaker-modelcard-matrixmetric-yaxisname}
+     */
     YAxisName?: string[] | undefined;
 };
 /**
  * A group of metric data that you use to initialize a metric group object.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-metricgroup.html}
  */
 export type MetricGroup = {
     /**
@@ -317,25 +431,30 @@ export type MetricGroup = {
      * - `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) .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-metricgroup.html#cfn-sagemaker-modelcard-metricgroup-metricdata}
      */
     MetricData: (SimpleMetric | LinearGraphMetric | BarChartMetric | MatrixMetric)[];
     /**
      * The metric group name.
      * @pattern .{1,63}
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-metricgroup.html#cfn-sagemaker-modelcard-metricgroup-name}
      */
     Name: string;
 };
 /**
  * An overview about the model.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-modeloverview.html}
  */
 export type ModelOverview = {
     /**
      * The algorithm used to solve the problem.
      * @maxLength 1024
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-modeloverview.html#cfn-sagemaker-modelcard-modeloverview-algorithmtype}
      */
     AlgorithmType?: string | undefined;
     /**
      * An overview about model inference.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-modeloverview.html#cfn-sagemaker-modelcard-modeloverview-inferenceenvironment}
      */
     InferenceEnvironment?: {
         /**
@@ -345,123 +464,151 @@ export type ModelOverview = {
     } | undefined;
     /**
      * The location of the model artifact.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-modeloverview.html#cfn-sagemaker-modelcard-modeloverview-modelartifact}
      */
     ModelArtifact?: string[] | undefined;
     /**
      * The creator of the model.
      * @maxLength 1024
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-modeloverview.html#cfn-sagemaker-modelcard-modeloverview-modelcreator}
      */
     ModelCreator?: string | undefined;
     /**
      * A description of the model.
      * @maxLength 1024
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-modeloverview.html#cfn-sagemaker-modelcard-modeloverview-modeldescription}
      */
     ModelDescription?: string | undefined;
     /**
      * The SageMaker AI Model ARN or non- SageMaker AI Model ID.
      * @maxLength 1024
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-modeloverview.html#cfn-sagemaker-modelcard-modeloverview-modelid}
      */
     ModelId?: string | undefined;
     /**
      * The name of the model.
      * @maxLength 1024
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-modeloverview.html#cfn-sagemaker-modelcard-modeloverview-modelname}
      */
     ModelName?: string | undefined;
     /**
      * The owner of the model.
      * @maxLength 1024
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-modeloverview.html#cfn-sagemaker-modelcard-modeloverview-modelowner}
      */
     ModelOwner?: string | undefined;
     /**
      * The version of the model.
      * @min 1
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-modeloverview.html#cfn-sagemaker-modelcard-modeloverview-modelversion}
      */
     ModelVersion?: number | undefined;
     /**
      * The problem being solved with the model.
      * @maxLength 1024
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-modeloverview.html#cfn-sagemaker-modelcard-modeloverview-problemtype}
      */
     ProblemType?: string | undefined;
 };
+/**
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-modelpackagecreator.html}
+ */
 export type ModelPackageCreator = {
     /**
      * The name of the user's profile in Studio
      * @maxLength 63
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-modelpackagecreator.html#cfn-sagemaker-modelcard-modelpackagecreator-userprofilename}
      */
     UserProfileName?: string | undefined;
 };
 /**
  * Metadata information related to model package version
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-modelpackagedetails.html}
  */
 export type ModelPackageDetails = {
     /**
      * A description provided for the model approval
      * @maxLength 1024
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-modelpackagedetails.html#cfn-sagemaker-modelcard-modelpackagedetails-approvaldescription}
      */
     ApprovalDescription?: string | undefined;
     /**
      * Information about the user who created model package.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-modelpackagedetails.html#cfn-sagemaker-modelcard-modelpackagedetails-createdby}
      */
     CreatedBy?: ModelPackageCreator | undefined;
     /**
      * The machine learning domain of the model package you specified. Common machine learning domains include computer vision and natural language processing.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-modelpackagedetails.html#cfn-sagemaker-modelcard-modelpackagedetails-domain}
      */
     Domain?: string | undefined;
     /**
      * Details about inference jobs that can be run with models based on this model package.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-modelpackagedetails.html#cfn-sagemaker-modelcard-modelpackagedetails-inferencespecification}
      */
     InferenceSpecification?: InferenceSpecification | undefined;
     /**
      * Current approval status of model package
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-modelpackagedetails.html#cfn-sagemaker-modelcard-modelpackagedetails-modelapprovalstatus}
      */
     ModelApprovalStatus?: "Approved" | "Rejected" | "PendingManualApproval" | undefined;
     /**
      * The Amazon Resource Name (ARN) of the model package
      * @minLength 1
      * @maxLength 2048
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-modelpackagedetails.html#cfn-sagemaker-modelcard-modelpackagedetails-modelpackagearn}
      */
     ModelPackageArn?: string | undefined;
     /**
      * A brief summary of the model package
      * @maxLength 1024
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-modelpackagedetails.html#cfn-sagemaker-modelcard-modelpackagedetails-modelpackagedescription}
      */
     ModelPackageDescription?: string | undefined;
     /**
      * If the model is a versioned model, the name of the model group that the versioned model belongs to.
      * @minLength 1
      * @maxLength 63
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-modelpackagedetails.html#cfn-sagemaker-modelcard-modelpackagedetails-modelpackagegroupname}
      */
     ModelPackageGroupName?: string | undefined;
     /**
      * Name of the model package
      * @minLength 1
      * @maxLength 63
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-modelpackagedetails.html#cfn-sagemaker-modelcard-modelpackagedetails-modelpackagename}
      */
     ModelPackageName?: string | undefined;
     /**
      * Current status of model package
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-modelpackagedetails.html#cfn-sagemaker-modelcard-modelpackagedetails-modelpackagestatus}
      */
     ModelPackageStatus?: "Pending" | "InProgress" | "Completed" | "Failed" | "Deleting" | undefined;
     /**
      * Version of the model package
      * @min 1
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-modelpackagedetails.html#cfn-sagemaker-modelcard-modelpackagedetails-modelpackageversion}
      */
     ModelPackageVersion?: number | undefined;
     /**
      * A list of algorithms that were used to create a model package.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-modelpackagedetails.html#cfn-sagemaker-modelcard-modelpackagedetails-sourcealgorithms}
      */
     SourceAlgorithms?: SourceAlgorithm[] | undefined;
     /**
      * The machine learning task you specified that your model package accomplishes. Common machine learning tasks include object detection and image classification.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-modelpackagedetails.html#cfn-sagemaker-modelcard-modelpackagedetails-task}
      */
     Task?: string | undefined;
 };
 /**
  * The function that is optimized during model training.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-objectivefunction.html}
  */
 export type ObjectiveFunction = {
     /**
      * A function object that details optimization direction, metric, and additional descriptions.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-objectivefunction.html#cfn-sagemaker-modelcard-objectivefunction-function}
      */
     Function?: {
         /**
@@ -477,48 +624,69 @@ export type ObjectiveFunction = {
     /**
      * Notes about the object function, including other considerations for possible objective functions.
      * @maxLength 1024
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-objectivefunction.html#cfn-sagemaker-modelcard-objectivefunction-notes}
      */
     Notes?: string | undefined;
 };
 /**
  * Risk rating of model.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-riskrating.html}
  */
 export type RiskRating = "High" | "Medium" | "Low" | "Unknown";
 /**
  * The security configuration used to protect model card data.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-securityconfig.html}
  */
 export type SecurityConfig = {
     /**
      * 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.
      * @maxLength 2048
      * @pattern .*
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-securityconfig.html#cfn-sagemaker-modelcard-securityconfig-kmskeyid}
      */
     KmsKeyId?: string | undefined;
 };
 /**
  * metric data
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-simplemetric.html}
  */
 export type SimpleMetric = {
     /**
      * @pattern .{1,255}
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-simplemetric.html#cfn-sagemaker-modelcard-simplemetric-name}
      */
     Name: string;
     /**
      * @maxLength 1024
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-simplemetric.html#cfn-sagemaker-modelcard-simplemetric-notes}
      */
     Notes?: string | undefined;
+    /**
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-simplemetric.html#cfn-sagemaker-modelcard-simplemetric-type}
+     */
     Type: "number" | "string" | "boolean";
+    /**
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-simplemetric.html#cfn-sagemaker-modelcard-simplemetric-value}
+     */
     Value: number | string | boolean;
+    /**
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-simplemetric.html#cfn-sagemaker-modelcard-simplemetric-xaxisname}
+     */
     XAxisName?: string | undefined;
+    /**
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-simplemetric.html#cfn-sagemaker-modelcard-simplemetric-yaxisname}
+     */
     YAxisName?: string | undefined;
 };
 /**
  * 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.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-sourcealgorithm.html}
  */
 export type SourceAlgorithm = {
     /**
      * 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.
      * @maxLength 170
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-sourcealgorithm.html#cfn-sagemaker-modelcard-sourcealgorithm-algorithmname}
      */
     AlgorithmName: string;
     /**
@@ -526,19 +694,23 @@ export type SourceAlgorithm = {
      *
      * > The model artifacts must be in an S3 bucket that is in the same AWS region as the algorithm.
      * @maxLength 1024
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-sourcealgorithm.html#cfn-sagemaker-modelcard-sourcealgorithm-modeldataurl}
      */
     ModelDataUrl?: string | undefined;
 };
 /**
  * The training details of the model
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-trainingdetails.html}
  */
 export type TrainingDetails = {
     /**
      * The function that is optimized during model training.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-trainingdetails.html#cfn-sagemaker-modelcard-trainingdetails-objectivefunction}
      */
     ObjectiveFunction?: ObjectiveFunction | undefined;
     /**
      * Details about any associated training jobs.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-trainingdetails.html#cfn-sagemaker-modelcard-trainingdetails-trainingjobdetails}
      */
     TrainingJobDetails?: {
         HyperParameters?: TrainingHyperParameter[] | undefined;
@@ -564,60 +736,72 @@ export type TrainingDetails = {
     /**
      * Any observations about training.
      * @maxLength 1024
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-trainingdetails.html#cfn-sagemaker-modelcard-trainingdetails-trainingobservations}
      */
     TrainingObservations?: string | undefined;
 };
 /**
  * A hyper parameter that was configured in training the model.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-traininghyperparameter.html}
  */
 export type TrainingHyperParameter = {
     /**
      * The name of the hyper parameter.
      * @pattern .{1,255}
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-traininghyperparameter.html#cfn-sagemaker-modelcard-traininghyperparameter-name}
      */
     Name: string;
     /**
      * The value specified for the hyper parameter.
      * @pattern .{1,255}
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-traininghyperparameter.html#cfn-sagemaker-modelcard-traininghyperparameter-value}
      */
     Value: string;
 };
 /**
  * A result from a SageMaker AI training job.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-trainingmetric.html}
  */
 export type TrainingMetric = {
     /**
      * The name of the result from the SageMaker AI training job.
      * @pattern .{1,255}
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-trainingmetric.html#cfn-sagemaker-modelcard-trainingmetric-name}
      */
     Name: string;
     /**
      * Any additional notes describing the result of the training job.
      * @maxLength 1024
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-trainingmetric.html#cfn-sagemaker-modelcard-trainingmetric-notes}
      */
     Notes?: string | undefined;
     /**
      * The value of a result from the SageMaker AI training job.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-trainingmetric.html#cfn-sagemaker-modelcard-trainingmetric-value}
      */
     Value: number;
 };
 /**
  * Information about the user who created or modified an experiment, trial, trial component, lineage group, project, or model card.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-usercontext.html}
  */
 export type UserContext = {
     /**
      * The domain associated with the user.
      * @default "UnsetValue"
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-usercontext.html#cfn-sagemaker-modelcard-usercontext-domainid}
      */
     DomainId?: string | undefined;
     /**
      * The Amazon Resource Name (ARN) of the user's profile.
      * @default "UnsetValue"
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-usercontext.html#cfn-sagemaker-modelcard-usercontext-userprofilearn}
      */
     UserProfileArn?: string | undefined;
     /**
      * The name of the user's profile.
      * @default "UnsetValue"
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-modelcard-usercontext.html#cfn-sagemaker-modelcard-usercontext-userprofilename}
      */
     UserProfileName?: string | undefined;
 };