1. Packages
  2. AWS Native
  3. API Docs
  4. sagemaker
  5. ModelCard

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.102.0 published on Tuesday, Apr 16, 2024 by Pulumi

aws-native.sagemaker.ModelCard

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.102.0 published on Tuesday, Apr 16, 2024 by Pulumi

    Resource Type definition for AWS::SageMaker::ModelCard.

    Create ModelCard Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new ModelCard(name: string, args: ModelCardArgs, opts?: CustomResourceOptions);
    @overload
    def ModelCard(resource_name: str,
                  args: ModelCardArgs,
                  opts: Optional[ResourceOptions] = None)
    
    @overload
    def ModelCard(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  content: Optional[ModelCardContentArgs] = None,
                  model_card_status: Optional[ModelCardStatus] = None,
                  created_by: Optional[ModelCardUserContextArgs] = None,
                  last_modified_by: Optional[ModelCardUserContextArgs] = None,
                  model_card_name: Optional[str] = None,
                  security_config: Optional[ModelCardSecurityConfigArgs] = None,
                  tags: Optional[Sequence[_root_inputs.TagArgs]] = None)
    func NewModelCard(ctx *Context, name string, args ModelCardArgs, opts ...ResourceOption) (*ModelCard, error)
    public ModelCard(string name, ModelCardArgs args, CustomResourceOptions? opts = null)
    public ModelCard(String name, ModelCardArgs args)
    public ModelCard(String name, ModelCardArgs args, CustomResourceOptions options)
    
    type: aws-native:sagemaker:ModelCard
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args ModelCardArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ModelCardArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ModelCardArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ModelCardArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ModelCardArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    const modelCardResource = new aws_native.sagemaker.ModelCard("modelCardResource", {
        content: {
            additionalInformation: {
                caveatsAndRecommendations: "string",
                customDetails: {
                    string: "string",
                },
                ethicalConsiderations: "string",
            },
            businessDetails: {
                businessProblem: "string",
                businessStakeholders: "string",
                lineOfBusiness: "string",
            },
            evaluationDetails: [{
                name: "string",
                datasets: ["string"],
                evaluationJobArn: "string",
                evaluationObservation: "string",
                metadata: {
                    string: "string",
                },
                metricGroups: [{
                    metricData: [{
                        name: "string",
                        type: aws_native.sagemaker.ModelCardSimpleMetricType.Number,
                        value: 0,
                        notes: "string",
                        xAxisName: "string",
                        yAxisName: "string",
                    }],
                    name: "string",
                }],
            }],
            intendedUses: {
                explanationsForRiskRating: "string",
                factorsAffectingModelEfficiency: "string",
                intendedUses: "string",
                purposeOfModel: "string",
                riskRating: aws_native.sagemaker.ModelCardRiskRating.High,
            },
            modelOverview: {
                algorithmType: "string",
                inferenceEnvironment: {
                    containerImage: ["string"],
                },
                modelArtifact: ["string"],
                modelCreator: "string",
                modelDescription: "string",
                modelId: "string",
                modelName: "string",
                modelOwner: "string",
                modelVersion: 0,
                problemType: "string",
            },
            modelPackageDetails: {
                approvalDescription: "string",
                createdBy: {
                    userProfileName: "string",
                },
                domain: "string",
                inferenceSpecification: {
                    containers: [{
                        image: "string",
                        modelDataUrl: "string",
                        nearestModelName: "string",
                    }],
                },
                modelApprovalStatus: aws_native.sagemaker.ModelCardModelPackageDetailsModelApprovalStatus.Approved,
                modelPackageArn: "string",
                modelPackageDescription: "string",
                modelPackageGroupName: "string",
                modelPackageName: "string",
                modelPackageStatus: aws_native.sagemaker.ModelCardModelPackageDetailsModelPackageStatus.Pending,
                modelPackageVersion: 0,
                sourceAlgorithms: [{
                    algorithmName: "string",
                    modelDataUrl: "string",
                }],
                task: "string",
            },
            trainingDetails: {
                objectiveFunction: {
                    "function": {
                        condition: "string",
                        facet: "string",
                        "function": aws_native.sagemaker.ModelCardObjectiveFunctionFunctionPropertiesFunction.Maximize,
                    },
                    notes: "string",
                },
                trainingJobDetails: {
                    hyperParameters: [{
                        name: "string",
                        value: "string",
                    }],
                    trainingArn: "string",
                    trainingDatasets: ["string"],
                    trainingEnvironment: {
                        containerImage: ["string"],
                    },
                    trainingMetrics: [{
                        name: "string",
                        value: 0,
                        notes: "string",
                    }],
                    userProvidedHyperParameters: [{
                        name: "string",
                        value: "string",
                    }],
                    userProvidedTrainingMetrics: [{
                        name: "string",
                        value: 0,
                        notes: "string",
                    }],
                },
                trainingObservations: "string",
            },
        },
        modelCardStatus: aws_native.sagemaker.ModelCardStatus.Draft,
        createdBy: {
            domainId: "string",
            userProfileArn: "string",
            userProfileName: "string",
        },
        lastModifiedBy: {
            domainId: "string",
            userProfileArn: "string",
            userProfileName: "string",
        },
        modelCardName: "string",
        securityConfig: {
            kmsKeyId: "string",
        },
        tags: [{
            key: "string",
            value: "string",
        }],
    });
    
    Coming soon!
    

    ModelCard Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The ModelCard resource accepts the following input properties:

    Content Pulumi.AwsNative.SageMaker.Inputs.ModelCardContent
    ModelCardStatus Pulumi.AwsNative.SageMaker.ModelCardStatus
    The approval status of the model card within your organization. Different organizations might have different criteria for model card review and approval.
    CreatedBy Pulumi.AwsNative.SageMaker.Inputs.ModelCardUserContext
    Information about the user who created or modified an experiment, trial, trial component, lineage group, project, or model card.
    LastModifiedBy Pulumi.AwsNative.SageMaker.Inputs.ModelCardUserContext
    Information about the user who created or modified an experiment, trial, trial component, lineage group, project, or model card.
    ModelCardName string
    The unique name of the model card.
    SecurityConfig Pulumi.AwsNative.SageMaker.Inputs.ModelCardSecurityConfig
    Tags List<Pulumi.AwsNative.Inputs.Tag>
    Key-value pairs used to manage metadata for model cards.
    Content ModelCardContentArgs
    ModelCardStatus ModelCardStatus
    The approval status of the model card within your organization. Different organizations might have different criteria for model card review and approval.
    CreatedBy ModelCardUserContextArgs
    Information about the user who created or modified an experiment, trial, trial component, lineage group, project, or model card.
    LastModifiedBy ModelCardUserContextArgs
    Information about the user who created or modified an experiment, trial, trial component, lineage group, project, or model card.
    ModelCardName string
    The unique name of the model card.
    SecurityConfig ModelCardSecurityConfigArgs
    Tags TagArgs
    Key-value pairs used to manage metadata for model cards.
    content ModelCardContent
    modelCardStatus ModelCardStatus
    The approval status of the model card within your organization. Different organizations might have different criteria for model card review and approval.
    createdBy ModelCardUserContext
    Information about the user who created or modified an experiment, trial, trial component, lineage group, project, or model card.
    lastModifiedBy ModelCardUserContext
    Information about the user who created or modified an experiment, trial, trial component, lineage group, project, or model card.
    modelCardName String
    The unique name of the model card.
    securityConfig ModelCardSecurityConfig
    tags List<Tag>
    Key-value pairs used to manage metadata for model cards.
    content ModelCardContent
    modelCardStatus ModelCardStatus
    The approval status of the model card within your organization. Different organizations might have different criteria for model card review and approval.
    createdBy ModelCardUserContext
    Information about the user who created or modified an experiment, trial, trial component, lineage group, project, or model card.
    lastModifiedBy ModelCardUserContext
    Information about the user who created or modified an experiment, trial, trial component, lineage group, project, or model card.
    modelCardName string
    The unique name of the model card.
    securityConfig ModelCardSecurityConfig
    tags Tag[]
    Key-value pairs used to manage metadata for model cards.
    content ModelCardContentArgs
    model_card_status ModelCardStatus
    The approval status of the model card within your organization. Different organizations might have different criteria for model card review and approval.
    created_by ModelCardUserContextArgs
    Information about the user who created or modified an experiment, trial, trial component, lineage group, project, or model card.
    last_modified_by ModelCardUserContextArgs
    Information about the user who created or modified an experiment, trial, trial component, lineage group, project, or model card.
    model_card_name str
    The unique name of the model card.
    security_config ModelCardSecurityConfigArgs
    tags Sequence[TagArgs]
    Key-value pairs used to manage metadata for model cards.
    content Property Map
    modelCardStatus "Draft" | "PendingReview" | "Approved" | "Archived"
    The approval status of the model card within your organization. Different organizations might have different criteria for model card review and approval.
    createdBy Property Map
    Information about the user who created or modified an experiment, trial, trial component, lineage group, project, or model card.
    lastModifiedBy Property Map
    Information about the user who created or modified an experiment, trial, trial component, lineage group, project, or model card.
    modelCardName String
    The unique name of the model card.
    securityConfig Property Map
    tags List<Property Map>
    Key-value pairs used to manage metadata for model cards.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the ModelCard resource produces the following output properties:

    CreationTime string
    The date and time the model card was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    LastModifiedTime string
    The date and time the model card was last modified.
    ModelCardArn string
    The Amazon Resource Name (ARN) of the successfully created model card.
    ModelCardProcessingStatus Pulumi.AwsNative.SageMaker.ModelCardProcessingStatus
    The processing status of model card deletion. The ModelCardProcessingStatus updates throughout the different deletion steps.
    ModelCardVersion int
    A version of the model card.
    CreationTime string
    The date and time the model card was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    LastModifiedTime string
    The date and time the model card was last modified.
    ModelCardArn string
    The Amazon Resource Name (ARN) of the successfully created model card.
    ModelCardProcessingStatus ModelCardProcessingStatus
    The processing status of model card deletion. The ModelCardProcessingStatus updates throughout the different deletion steps.
    ModelCardVersion int
    A version of the model card.
    creationTime String
    The date and time the model card was created.
    id String
    The provider-assigned unique ID for this managed resource.
    lastModifiedTime String
    The date and time the model card was last modified.
    modelCardArn String
    The Amazon Resource Name (ARN) of the successfully created model card.
    modelCardProcessingStatus ModelCardProcessingStatus
    The processing status of model card deletion. The ModelCardProcessingStatus updates throughout the different deletion steps.
    modelCardVersion Integer
    A version of the model card.
    creationTime string
    The date and time the model card was created.
    id string
    The provider-assigned unique ID for this managed resource.
    lastModifiedTime string
    The date and time the model card was last modified.
    modelCardArn string
    The Amazon Resource Name (ARN) of the successfully created model card.
    modelCardProcessingStatus ModelCardProcessingStatus
    The processing status of model card deletion. The ModelCardProcessingStatus updates throughout the different deletion steps.
    modelCardVersion number
    A version of the model card.
    creation_time str
    The date and time the model card was created.
    id str
    The provider-assigned unique ID for this managed resource.
    last_modified_time str
    The date and time the model card was last modified.
    model_card_arn str
    The Amazon Resource Name (ARN) of the successfully created model card.
    model_card_processing_status ModelCardProcessingStatus
    The processing status of model card deletion. The ModelCardProcessingStatus updates throughout the different deletion steps.
    model_card_version int
    A version of the model card.
    creationTime String
    The date and time the model card was created.
    id String
    The provider-assigned unique ID for this managed resource.
    lastModifiedTime String
    The date and time the model card was last modified.
    modelCardArn String
    The Amazon Resource Name (ARN) of the successfully created model card.
    modelCardProcessingStatus "UnsetValue" | "DeleteInProgress" | "DeletePending" | "ContentDeleted" | "ExportJobsDeleted" | "DeleteCompleted" | "DeleteFailed"
    The processing status of model card deletion. The ModelCardProcessingStatus updates throughout the different deletion steps.
    modelCardVersion Number
    A version of the model card.

    Supporting Types

    ModelCardAdditionalInformation, ModelCardAdditionalInformationArgs

    CaveatsAndRecommendations string
    Caveats and recommendations for people who might use this model in their applications.
    CustomDetails Dictionary<string, string>
    customer details.
    EthicalConsiderations string
    Any ethical considerations that the author wants to provide.
    CaveatsAndRecommendations string
    Caveats and recommendations for people who might use this model in their applications.
    CustomDetails map[string]string
    customer details.
    EthicalConsiderations string
    Any ethical considerations that the author wants to provide.
    caveatsAndRecommendations String
    Caveats and recommendations for people who might use this model in their applications.
    customDetails Map<String,String>
    customer details.
    ethicalConsiderations String
    Any ethical considerations that the author wants to provide.
    caveatsAndRecommendations string
    Caveats and recommendations for people who might use this model in their applications.
    customDetails {[key: string]: string}
    customer details.
    ethicalConsiderations string
    Any ethical considerations that the author wants to provide.
    caveats_and_recommendations str
    Caveats and recommendations for people who might use this model in their applications.
    custom_details Mapping[str, str]
    customer details.
    ethical_considerations str
    Any ethical considerations that the author wants to provide.
    caveatsAndRecommendations String
    Caveats and recommendations for people who might use this model in their applications.
    customDetails Map<String>
    customer details.
    ethicalConsiderations String
    Any ethical considerations that the author wants to provide.

    ModelCardBarChartMetric, ModelCardBarChartMetricArgs

    name String
    type ModelCardBarChartMetricType
    value List<Double>
    notes String
    xAxisName List<String>
    yAxisName String
    name String
    type "bar_chart"
    value List<Number>
    notes String
    xAxisName List<String>
    yAxisName String

    ModelCardBarChartMetricType, ModelCardBarChartMetricTypeArgs

    BarChart
    bar_chart
    ModelCardBarChartMetricTypeBarChart
    bar_chart
    BarChart
    bar_chart
    BarChart
    bar_chart
    BAR_CHART
    bar_chart
    "bar_chart"
    bar_chart

    ModelCardBusinessDetails, ModelCardBusinessDetailsArgs

    BusinessProblem string
    What business problem does the model solve?
    BusinessStakeholders string
    Business stakeholders.
    LineOfBusiness string
    Line of business.
    BusinessProblem string
    What business problem does the model solve?
    BusinessStakeholders string
    Business stakeholders.
    LineOfBusiness string
    Line of business.
    businessProblem String
    What business problem does the model solve?
    businessStakeholders String
    Business stakeholders.
    lineOfBusiness String
    Line of business.
    businessProblem string
    What business problem does the model solve?
    businessStakeholders string
    Business stakeholders.
    lineOfBusiness string
    Line of business.
    business_problem str
    What business problem does the model solve?
    business_stakeholders str
    Business stakeholders.
    line_of_business str
    Line of business.
    businessProblem String
    What business problem does the model solve?
    businessStakeholders String
    Business stakeholders.
    lineOfBusiness String
    Line of business.

    ModelCardContainer, ModelCardContainerArgs

    Image string
    Inference environment path. The Amazon EC2 Container Registry (Amazon ECR) path where inference code is stored.
    ModelDataUrl string
    The Amazon S3 path where the model artifacts, which result from model training, are stored.
    NearestModelName string
    The name of a pre-trained machine learning benchmarked by Amazon SageMaker Inference Recommender model that matches your model.
    Image string
    Inference environment path. The Amazon EC2 Container Registry (Amazon ECR) path where inference code is stored.
    ModelDataUrl string
    The Amazon S3 path where the model artifacts, which result from model training, are stored.
    NearestModelName string
    The name of a pre-trained machine learning benchmarked by Amazon SageMaker Inference Recommender model that matches your model.
    image String
    Inference environment path. The Amazon EC2 Container Registry (Amazon ECR) path where inference code is stored.
    modelDataUrl String
    The Amazon S3 path where the model artifacts, which result from model training, are stored.
    nearestModelName String
    The name of a pre-trained machine learning benchmarked by Amazon SageMaker Inference Recommender model that matches your model.
    image string
    Inference environment path. The Amazon EC2 Container Registry (Amazon ECR) path where inference code is stored.
    modelDataUrl string
    The Amazon S3 path where the model artifacts, which result from model training, are stored.
    nearestModelName string
    The name of a pre-trained machine learning benchmarked by Amazon SageMaker Inference Recommender model that matches your model.
    image str
    Inference environment path. The Amazon EC2 Container Registry (Amazon ECR) path where inference code is stored.
    model_data_url str
    The Amazon S3 path where the model artifacts, which result from model training, are stored.
    nearest_model_name str
    The name of a pre-trained machine learning benchmarked by Amazon SageMaker Inference Recommender model that matches your model.
    image String
    Inference environment path. The Amazon EC2 Container Registry (Amazon ECR) path where inference code is stored.
    modelDataUrl String
    The Amazon S3 path where the model artifacts, which result from model training, are stored.
    nearestModelName String
    The name of a pre-trained machine learning benchmarked by Amazon SageMaker Inference Recommender model that matches your model.

    ModelCardContent, ModelCardContentArgs

    ModelCardEvaluationDetail, ModelCardEvaluationDetailArgs

    Name string
    Datasets List<string>
    EvaluationJobArn string
    EvaluationObservation string
    Metadata Dictionary<string, string>
    additional attributes associated with the evaluation results.
    MetricGroups List<Pulumi.AwsNative.SageMaker.Inputs.ModelCardMetricGroup>
    Name string
    Datasets []string
    EvaluationJobArn string
    EvaluationObservation string
    Metadata map[string]string
    additional attributes associated with the evaluation results.
    MetricGroups []ModelCardMetricGroup
    name String
    datasets List<String>
    evaluationJobArn String
    evaluationObservation String
    metadata Map<String,String>
    additional attributes associated with the evaluation results.
    metricGroups List<ModelCardMetricGroup>
    name string
    datasets string[]
    evaluationJobArn string
    evaluationObservation string
    metadata {[key: string]: string}
    additional attributes associated with the evaluation results.
    metricGroups ModelCardMetricGroup[]
    name str
    datasets Sequence[str]
    evaluation_job_arn str
    evaluation_observation str
    metadata Mapping[str, str]
    additional attributes associated with the evaluation results.
    metric_groups Sequence[ModelCardMetricGroup]
    name String
    datasets List<String>
    evaluationJobArn String
    evaluationObservation String
    metadata Map<String>
    additional attributes associated with the evaluation results.
    metricGroups List<Property Map>

    ModelCardInferenceSpecification, ModelCardInferenceSpecificationArgs

    Containers List<Pulumi.AwsNative.SageMaker.Inputs.ModelCardContainer>
    Contains inference related information which were used to create model package.
    Containers []ModelCardContainer
    Contains inference related information which were used to create model package.
    containers List<ModelCardContainer>
    Contains inference related information which were used to create model package.
    containers ModelCardContainer[]
    Contains inference related information which were used to create model package.
    containers Sequence[ModelCardContainer]
    Contains inference related information which were used to create model package.
    containers List<Property Map>
    Contains inference related information which were used to create model package.

    ModelCardIntendedUses, ModelCardIntendedUsesArgs

    ExplanationsForRiskRating string
    FactorsAffectingModelEfficiency string
    IntendedUses string
    intended use cases.
    PurposeOfModel string
    Why the model was developed?
    RiskRating ModelCardRiskRating
    explanationsForRiskRating String
    factorsAffectingModelEfficiency String
    intendedUses String
    intended use cases.
    purposeOfModel String
    Why the model was developed?
    riskRating ModelCardRiskRating
    explanationsForRiskRating string
    factorsAffectingModelEfficiency string
    intendedUses string
    intended use cases.
    purposeOfModel string
    Why the model was developed?
    riskRating ModelCardRiskRating

    ModelCardLinearGraphMetric, ModelCardLinearGraphMetricArgs

    name String
    type ModelCardLinearGraphMetricType
    value List<List<Double>>
    notes String
    xAxisName String
    yAxisName String
    name String
    type "linear_graph"
    value List<List<Number>>
    notes String
    xAxisName String
    yAxisName String

    ModelCardLinearGraphMetricType, ModelCardLinearGraphMetricTypeArgs

    LinearGraph
    linear_graph
    ModelCardLinearGraphMetricTypeLinearGraph
    linear_graph
    LinearGraph
    linear_graph
    LinearGraph
    linear_graph
    LINEAR_GRAPH
    linear_graph
    "linear_graph"
    linear_graph

    ModelCardMatrixMetric, ModelCardMatrixMetricArgs

    Name string
    Type Pulumi.AwsNative.SageMaker.ModelCardMatrixMetricType
    Value List<ImmutableArray<double>>
    Notes string
    XAxisName List<string>
    YAxisName List<string>
    Name string
    Type ModelCardMatrixMetricType
    Value [][]float64
    Notes string
    XAxisName []string
    YAxisName []string
    name String
    type ModelCardMatrixMetricType
    value List<List<Double>>
    notes String
    xAxisName List<String>
    yAxisName List<String>
    name string
    type ModelCardMatrixMetricType
    value number[][]
    notes string
    xAxisName string[]
    yAxisName string[]
    name str
    type ModelCardMatrixMetricType
    value Sequence[Sequence[float]]
    notes str
    x_axis_name Sequence[str]
    y_axis_name Sequence[str]
    name String
    type "matrix"
    value List<List<Number>>
    notes String
    xAxisName List<String>
    yAxisName List<String>

    ModelCardMatrixMetricType, ModelCardMatrixMetricTypeArgs

    Matrix
    matrix
    ModelCardMatrixMetricTypeMatrix
    matrix
    Matrix
    matrix
    Matrix
    matrix
    MATRIX
    matrix
    "matrix"
    matrix

    ModelCardMetricGroup, ModelCardMetricGroupArgs

    MetricData List<object>
    Name string
    MetricData []interface{}
    Name string
    metricData List<Object>
    name String
    metricData (ModelCardSimpleMetric | ModelCardLinearGraphMetric | ModelCardBarChartMetric | ModelCardMatrixMetric)[]
    name string
    metric_data Sequence[Union[ModelCardSimpleMetric, ModelCardLinearGraphMetric, ModelCardBarChartMetric, ModelCardMatrixMetric]]
    name str
    metricData List<Property Map | Property Map | Property Map | Property Map>
    name String

    ModelCardModelOverview, ModelCardModelOverviewArgs

    AlgorithmType string
    Algorithm used to solve the problem.
    InferenceEnvironment Pulumi.AwsNative.SageMaker.Inputs.ModelCardModelOverviewInferenceEnvironmentProperties
    Overview about the inference.
    ModelArtifact List<string>
    Location of the model artifact.
    ModelCreator string
    Creator of model.
    ModelDescription string
    description of model.
    ModelId string
    SageMaker Model Arn or Non SageMaker Model id.
    ModelName string
    Name of the model.
    ModelOwner string
    Owner of model.
    ModelVersion double
    Version of the model.
    ProblemType string
    Problem being solved with the model.
    AlgorithmType string
    Algorithm used to solve the problem.
    InferenceEnvironment ModelCardModelOverviewInferenceEnvironmentProperties
    Overview about the inference.
    ModelArtifact []string
    Location of the model artifact.
    ModelCreator string
    Creator of model.
    ModelDescription string
    description of model.
    ModelId string
    SageMaker Model Arn or Non SageMaker Model id.
    ModelName string
    Name of the model.
    ModelOwner string
    Owner of model.
    ModelVersion float64
    Version of the model.
    ProblemType string
    Problem being solved with the model.
    algorithmType String
    Algorithm used to solve the problem.
    inferenceEnvironment ModelCardModelOverviewInferenceEnvironmentProperties
    Overview about the inference.
    modelArtifact List<String>
    Location of the model artifact.
    modelCreator String
    Creator of model.
    modelDescription String
    description of model.
    modelId String
    SageMaker Model Arn or Non SageMaker Model id.
    modelName String
    Name of the model.
    modelOwner String
    Owner of model.
    modelVersion Double
    Version of the model.
    problemType String
    Problem being solved with the model.
    algorithmType string
    Algorithm used to solve the problem.
    inferenceEnvironment ModelCardModelOverviewInferenceEnvironmentProperties
    Overview about the inference.
    modelArtifact string[]
    Location of the model artifact.
    modelCreator string
    Creator of model.
    modelDescription string
    description of model.
    modelId string
    SageMaker Model Arn or Non SageMaker Model id.
    modelName string
    Name of the model.
    modelOwner string
    Owner of model.
    modelVersion number
    Version of the model.
    problemType string
    Problem being solved with the model.
    algorithm_type str
    Algorithm used to solve the problem.
    inference_environment ModelCardModelOverviewInferenceEnvironmentProperties
    Overview about the inference.
    model_artifact Sequence[str]
    Location of the model artifact.
    model_creator str
    Creator of model.
    model_description str
    description of model.
    model_id str
    SageMaker Model Arn or Non SageMaker Model id.
    model_name str
    Name of the model.
    model_owner str
    Owner of model.
    model_version float
    Version of the model.
    problem_type str
    Problem being solved with the model.
    algorithmType String
    Algorithm used to solve the problem.
    inferenceEnvironment Property Map
    Overview about the inference.
    modelArtifact List<String>
    Location of the model artifact.
    modelCreator String
    Creator of model.
    modelDescription String
    description of model.
    modelId String
    SageMaker Model Arn or Non SageMaker Model id.
    modelName String
    Name of the model.
    modelOwner String
    Owner of model.
    modelVersion Number
    Version of the model.
    problemType String
    Problem being solved with the model.

    ModelCardModelOverviewInferenceEnvironmentProperties, ModelCardModelOverviewInferenceEnvironmentPropertiesArgs

    ContainerImage List<string>
    SageMaker inference image uri.
    ContainerImage []string
    SageMaker inference image uri.
    containerImage List<String>
    SageMaker inference image uri.
    containerImage string[]
    SageMaker inference image uri.
    container_image Sequence[str]
    SageMaker inference image uri.
    containerImage List<String>
    SageMaker inference image uri.

    ModelCardModelPackageCreator, ModelCardModelPackageCreatorArgs

    UserProfileName string
    The name of the user's profile in Studio
    UserProfileName string
    The name of the user's profile in Studio
    userProfileName String
    The name of the user's profile in Studio
    userProfileName string
    The name of the user's profile in Studio
    user_profile_name str
    The name of the user's profile in Studio
    userProfileName String
    The name of the user's profile in Studio

    ModelCardModelPackageDetails, ModelCardModelPackageDetailsArgs

    ApprovalDescription string
    A description provided for the model approval
    CreatedBy Pulumi.AwsNative.SageMaker.Inputs.ModelCardModelPackageCreator
    Information about the user who created model package.
    Domain string
    The machine learning domain of the model package you specified. Common machine learning domains include computer vision and natural language processing.
    InferenceSpecification Pulumi.AwsNative.SageMaker.Inputs.ModelCardInferenceSpecification
    Details about inference jobs that can be run with models based on this model package.
    ModelApprovalStatus Pulumi.AwsNative.SageMaker.ModelCardModelPackageDetailsModelApprovalStatus
    Current approval status of model package
    ModelPackageArn string
    The Amazon Resource Name (ARN) of the model package
    ModelPackageDescription string
    A brief summary of the model package
    ModelPackageGroupName string
    If the model is a versioned model, the name of the model group that the versioned model belongs to.
    ModelPackageName string
    Name of the model package
    ModelPackageStatus Pulumi.AwsNative.SageMaker.ModelCardModelPackageDetailsModelPackageStatus
    Current status of model package
    ModelPackageVersion double
    Version of the model package
    SourceAlgorithms List<Pulumi.AwsNative.SageMaker.Inputs.ModelCardSourceAlgorithm>
    A list of algorithms that were used to create a model package.
    Task string
    The machine learning task you specified that your model package accomplishes. Common machine learning tasks include object detection and image classification.
    ApprovalDescription string
    A description provided for the model approval
    CreatedBy ModelCardModelPackageCreator
    Information about the user who created model package.
    Domain string
    The machine learning domain of the model package you specified. Common machine learning domains include computer vision and natural language processing.
    InferenceSpecification ModelCardInferenceSpecification
    Details about inference jobs that can be run with models based on this model package.
    ModelApprovalStatus ModelCardModelPackageDetailsModelApprovalStatus
    Current approval status of model package
    ModelPackageArn string
    The Amazon Resource Name (ARN) of the model package
    ModelPackageDescription string
    A brief summary of the model package
    ModelPackageGroupName string
    If the model is a versioned model, the name of the model group that the versioned model belongs to.
    ModelPackageName string
    Name of the model package
    ModelPackageStatus ModelCardModelPackageDetailsModelPackageStatus
    Current status of model package
    ModelPackageVersion float64
    Version of the model package
    SourceAlgorithms []ModelCardSourceAlgorithm
    A list of algorithms that were used to create a model package.
    Task string
    The machine learning task you specified that your model package accomplishes. Common machine learning tasks include object detection and image classification.
    approvalDescription String
    A description provided for the model approval
    createdBy ModelCardModelPackageCreator
    Information about the user who created model package.
    domain String
    The machine learning domain of the model package you specified. Common machine learning domains include computer vision and natural language processing.
    inferenceSpecification ModelCardInferenceSpecification
    Details about inference jobs that can be run with models based on this model package.
    modelApprovalStatus ModelCardModelPackageDetailsModelApprovalStatus
    Current approval status of model package
    modelPackageArn String
    The Amazon Resource Name (ARN) of the model package
    modelPackageDescription String
    A brief summary of the model package
    modelPackageGroupName String
    If the model is a versioned model, the name of the model group that the versioned model belongs to.
    modelPackageName String
    Name of the model package
    modelPackageStatus ModelCardModelPackageDetailsModelPackageStatus
    Current status of model package
    modelPackageVersion Double
    Version of the model package
    sourceAlgorithms List<ModelCardSourceAlgorithm>
    A list of algorithms that were used to create a model package.
    task String
    The machine learning task you specified that your model package accomplishes. Common machine learning tasks include object detection and image classification.
    approvalDescription string
    A description provided for the model approval
    createdBy ModelCardModelPackageCreator
    Information about the user who created model package.
    domain string
    The machine learning domain of the model package you specified. Common machine learning domains include computer vision and natural language processing.
    inferenceSpecification ModelCardInferenceSpecification
    Details about inference jobs that can be run with models based on this model package.
    modelApprovalStatus ModelCardModelPackageDetailsModelApprovalStatus
    Current approval status of model package
    modelPackageArn string
    The Amazon Resource Name (ARN) of the model package
    modelPackageDescription string
    A brief summary of the model package
    modelPackageGroupName string
    If the model is a versioned model, the name of the model group that the versioned model belongs to.
    modelPackageName string
    Name of the model package
    modelPackageStatus ModelCardModelPackageDetailsModelPackageStatus
    Current status of model package
    modelPackageVersion number
    Version of the model package
    sourceAlgorithms ModelCardSourceAlgorithm[]
    A list of algorithms that were used to create a model package.
    task string
    The machine learning task you specified that your model package accomplishes. Common machine learning tasks include object detection and image classification.
    approval_description str
    A description provided for the model approval
    created_by ModelCardModelPackageCreator
    Information about the user who created model package.
    domain str
    The machine learning domain of the model package you specified. Common machine learning domains include computer vision and natural language processing.
    inference_specification ModelCardInferenceSpecification
    Details about inference jobs that can be run with models based on this model package.
    model_approval_status ModelCardModelPackageDetailsModelApprovalStatus
    Current approval status of model package
    model_package_arn str
    The Amazon Resource Name (ARN) of the model package
    model_package_description str
    A brief summary of the model package
    model_package_group_name str
    If the model is a versioned model, the name of the model group that the versioned model belongs to.
    model_package_name str
    Name of the model package
    model_package_status ModelCardModelPackageDetailsModelPackageStatus
    Current status of model package
    model_package_version float
    Version of the model package
    source_algorithms Sequence[ModelCardSourceAlgorithm]
    A list of algorithms that were used to create a model package.
    task str
    The machine learning task you specified that your model package accomplishes. Common machine learning tasks include object detection and image classification.
    approvalDescription String
    A description provided for the model approval
    createdBy Property Map
    Information about the user who created model package.
    domain String
    The machine learning domain of the model package you specified. Common machine learning domains include computer vision and natural language processing.
    inferenceSpecification Property Map
    Details about inference jobs that can be run with models based on this model package.
    modelApprovalStatus "Approved" | "Rejected" | "PendingManualApproval"
    Current approval status of model package
    modelPackageArn String
    The Amazon Resource Name (ARN) of the model package
    modelPackageDescription String
    A brief summary of the model package
    modelPackageGroupName String
    If the model is a versioned model, the name of the model group that the versioned model belongs to.
    modelPackageName String
    Name of the model package
    modelPackageStatus "Pending" | "InProgress" | "Completed" | "Failed" | "Deleting"
    Current status of model package
    modelPackageVersion Number
    Version of the model package
    sourceAlgorithms List<Property Map>
    A list of algorithms that were used to create a model package.
    task String
    The machine learning task you specified that your model package accomplishes. Common machine learning tasks include object detection and image classification.

    ModelCardModelPackageDetailsModelApprovalStatus, ModelCardModelPackageDetailsModelApprovalStatusArgs

    Approved
    Approved
    Rejected
    Rejected
    PendingManualApproval
    PendingManualApproval
    ModelCardModelPackageDetailsModelApprovalStatusApproved
    Approved
    ModelCardModelPackageDetailsModelApprovalStatusRejected
    Rejected
    ModelCardModelPackageDetailsModelApprovalStatusPendingManualApproval
    PendingManualApproval
    Approved
    Approved
    Rejected
    Rejected
    PendingManualApproval
    PendingManualApproval
    Approved
    Approved
    Rejected
    Rejected
    PendingManualApproval
    PendingManualApproval
    APPROVED
    Approved
    REJECTED
    Rejected
    PENDING_MANUAL_APPROVAL
    PendingManualApproval
    "Approved"
    Approved
    "Rejected"
    Rejected
    "PendingManualApproval"
    PendingManualApproval

    ModelCardModelPackageDetailsModelPackageStatus, ModelCardModelPackageDetailsModelPackageStatusArgs

    Pending
    Pending
    InProgress
    InProgress
    Completed
    Completed
    Failed
    Failed
    Deleting
    Deleting
    ModelCardModelPackageDetailsModelPackageStatusPending
    Pending
    ModelCardModelPackageDetailsModelPackageStatusInProgress
    InProgress
    ModelCardModelPackageDetailsModelPackageStatusCompleted
    Completed
    ModelCardModelPackageDetailsModelPackageStatusFailed
    Failed
    ModelCardModelPackageDetailsModelPackageStatusDeleting
    Deleting
    Pending
    Pending
    InProgress
    InProgress
    Completed
    Completed
    Failed
    Failed
    Deleting
    Deleting
    Pending
    Pending
    InProgress
    InProgress
    Completed
    Completed
    Failed
    Failed
    Deleting
    Deleting
    PENDING
    Pending
    IN_PROGRESS
    InProgress
    COMPLETED
    Completed
    FAILED
    Failed
    DELETING
    Deleting
    "Pending"
    Pending
    "InProgress"
    InProgress
    "Completed"
    Completed
    "Failed"
    Failed
    "Deleting"
    Deleting

    ModelCardObjectiveFunction, ModelCardObjectiveFunctionArgs

    Function Pulumi.AwsNative.SageMaker.Inputs.ModelCardObjectiveFunctionFunctionProperties
    objective function that training job is optimized for.
    Notes string
    Function ModelCardObjectiveFunctionFunctionProperties
    objective function that training job is optimized for.
    Notes string
    function ModelCardObjectiveFunctionFunctionProperties
    objective function that training job is optimized for.
    notes String
    function ModelCardObjectiveFunctionFunctionProperties
    objective function that training job is optimized for.
    notes string
    function ModelCardObjectiveFunctionFunctionProperties
    objective function that training job is optimized for.
    notes str
    function Property Map
    objective function that training job is optimized for.
    notes String

    ModelCardObjectiveFunctionFunctionProperties, ModelCardObjectiveFunctionFunctionPropertiesArgs

    ModelCardObjectiveFunctionFunctionPropertiesFunction, ModelCardObjectiveFunctionFunctionPropertiesFunctionArgs

    Maximize
    Maximize
    Minimize
    Minimize
    ModelCardObjectiveFunctionFunctionPropertiesFunctionMaximize
    Maximize
    ModelCardObjectiveFunctionFunctionPropertiesFunctionMinimize
    Minimize
    Maximize
    Maximize
    Minimize
    Minimize
    Maximize
    Maximize
    Minimize
    Minimize
    MAXIMIZE
    Maximize
    MINIMIZE
    Minimize
    "Maximize"
    Maximize
    "Minimize"
    Minimize

    ModelCardProcessingStatus, ModelCardProcessingStatusArgs

    UnsetValue
    UnsetValue
    DeleteInProgress
    DeleteInProgress
    DeletePending
    DeletePending
    ContentDeleted
    ContentDeleted
    ExportJobsDeleted
    ExportJobsDeleted
    DeleteCompleted
    DeleteCompleted
    DeleteFailed
    DeleteFailed
    ModelCardProcessingStatusUnsetValue
    UnsetValue
    ModelCardProcessingStatusDeleteInProgress
    DeleteInProgress
    ModelCardProcessingStatusDeletePending
    DeletePending
    ModelCardProcessingStatusContentDeleted
    ContentDeleted
    ModelCardProcessingStatusExportJobsDeleted
    ExportJobsDeleted
    ModelCardProcessingStatusDeleteCompleted
    DeleteCompleted
    ModelCardProcessingStatusDeleteFailed
    DeleteFailed
    UnsetValue
    UnsetValue
    DeleteInProgress
    DeleteInProgress
    DeletePending
    DeletePending
    ContentDeleted
    ContentDeleted
    ExportJobsDeleted
    ExportJobsDeleted
    DeleteCompleted
    DeleteCompleted
    DeleteFailed
    DeleteFailed
    UnsetValue
    UnsetValue
    DeleteInProgress
    DeleteInProgress
    DeletePending
    DeletePending
    ContentDeleted
    ContentDeleted
    ExportJobsDeleted
    ExportJobsDeleted
    DeleteCompleted
    DeleteCompleted
    DeleteFailed
    DeleteFailed
    UNSET_VALUE
    UnsetValue
    DELETE_IN_PROGRESS
    DeleteInProgress
    DELETE_PENDING
    DeletePending
    CONTENT_DELETED
    ContentDeleted
    EXPORT_JOBS_DELETED
    ExportJobsDeleted
    DELETE_COMPLETED
    DeleteCompleted
    DELETE_FAILED
    DeleteFailed
    "UnsetValue"
    UnsetValue
    "DeleteInProgress"
    DeleteInProgress
    "DeletePending"
    DeletePending
    "ContentDeleted"
    ContentDeleted
    "ExportJobsDeleted"
    ExportJobsDeleted
    "DeleteCompleted"
    DeleteCompleted
    "DeleteFailed"
    DeleteFailed

    ModelCardRiskRating, ModelCardRiskRatingArgs

    High
    High
    Medium
    Medium
    Low
    Low
    Unknown
    Unknown
    ModelCardRiskRatingHigh
    High
    ModelCardRiskRatingMedium
    Medium
    ModelCardRiskRatingLow
    Low
    ModelCardRiskRatingUnknown
    Unknown
    High
    High
    Medium
    Medium
    Low
    Low
    Unknown
    Unknown
    High
    High
    Medium
    Medium
    Low
    Low
    Unknown
    Unknown
    HIGH
    High
    MEDIUM
    Medium
    LOW
    Low
    UNKNOWN
    Unknown
    "High"
    High
    "Medium"
    Medium
    "Low"
    Low
    "Unknown"
    Unknown

    ModelCardSecurityConfig, ModelCardSecurityConfigArgs

    KmsKeyId string
    A Key Management Service key ID to use for encrypting a model card.
    KmsKeyId string
    A Key Management Service key ID to use for encrypting a model card.
    kmsKeyId String
    A Key Management Service key ID to use for encrypting a model card.
    kmsKeyId string
    A Key Management Service key ID to use for encrypting a model card.
    kms_key_id str
    A Key Management Service key ID to use for encrypting a model card.
    kmsKeyId String
    A Key Management Service key ID to use for encrypting a model card.

    ModelCardSimpleMetric, ModelCardSimpleMetricArgs

    Name string
    Type ModelCardSimpleMetricType
    Value float64 | string | bool
    Notes string
    XAxisName string
    YAxisName string
    name String
    type ModelCardSimpleMetricType
    value Double | String | Boolean
    notes String
    xAxisName String
    yAxisName String
    name string
    type ModelCardSimpleMetricType
    value number | string | boolean
    notes string
    xAxisName string
    yAxisName string
    name String
    type "number" | "string" | "boolean"
    value Number | String | Boolean
    notes String
    xAxisName String
    yAxisName String

    ModelCardSimpleMetricType, ModelCardSimpleMetricTypeArgs

    Number
    number
    String
    string
    Boolean
    boolean
    ModelCardSimpleMetricTypeNumber
    number
    ModelCardSimpleMetricTypeString
    string
    ModelCardSimpleMetricTypeBoolean
    boolean
    Number
    number
    String
    string
    Boolean
    boolean
    Number
    number
    String
    string
    Boolean
    boolean
    NUMBER
    number
    STRING
    string
    BOOLEAN
    boolean
    "number"
    number
    "string"
    string
    "boolean"
    boolean

    ModelCardSourceAlgorithm, ModelCardSourceAlgorithmArgs

    AlgorithmName string
    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.
    ModelDataUrl string
    The Amazon S3 path where the model artifacts, which result from model training, are stored.
    AlgorithmName string
    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.
    ModelDataUrl string
    The Amazon S3 path where the model artifacts, which result from model training, are stored.
    algorithmName String
    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.
    modelDataUrl String
    The Amazon S3 path where the model artifacts, which result from model training, are stored.
    algorithmName string
    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.
    modelDataUrl string
    The Amazon S3 path where the model artifacts, which result from model training, are stored.
    algorithm_name str
    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.
    model_data_url str
    The Amazon S3 path where the model artifacts, which result from model training, are stored.
    algorithmName String
    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.
    modelDataUrl String
    The Amazon S3 path where the model artifacts, which result from model training, are stored.

    ModelCardStatus, ModelCardStatusArgs

    Draft
    Draft
    PendingReview
    PendingReview
    Approved
    Approved
    Archived
    Archived
    ModelCardStatusDraft
    Draft
    ModelCardStatusPendingReview
    PendingReview
    ModelCardStatusApproved
    Approved
    ModelCardStatusArchived
    Archived
    Draft
    Draft
    PendingReview
    PendingReview
    Approved
    Approved
    Archived
    Archived
    Draft
    Draft
    PendingReview
    PendingReview
    Approved
    Approved
    Archived
    Archived
    DRAFT
    Draft
    PENDING_REVIEW
    PendingReview
    APPROVED
    Approved
    ARCHIVED
    Archived
    "Draft"
    Draft
    "PendingReview"
    PendingReview
    "Approved"
    Approved
    "Archived"
    Archived

    ModelCardTrainingDetails, ModelCardTrainingDetailsArgs

    ModelCardTrainingDetailsTrainingJobDetailsProperties, ModelCardTrainingDetailsTrainingJobDetailsPropertiesArgs

    ModelCardTrainingDetailsTrainingJobDetailsPropertiesTrainingEnvironmentProperties, ModelCardTrainingDetailsTrainingJobDetailsPropertiesTrainingEnvironmentPropertiesArgs

    ContainerImage List<string>
    SageMaker training image uri.
    ContainerImage []string
    SageMaker training image uri.
    containerImage List<String>
    SageMaker training image uri.
    containerImage string[]
    SageMaker training image uri.
    container_image Sequence[str]
    SageMaker training image uri.
    containerImage List<String>
    SageMaker training image uri.

    ModelCardTrainingHyperParameter, ModelCardTrainingHyperParameterArgs

    Name string
    Value string
    Name string
    Value string
    name String
    value String
    name string
    value string
    name str
    value str
    name String
    value String

    ModelCardTrainingMetric, ModelCardTrainingMetricArgs

    Name string
    Value double
    Notes string
    Name string
    Value float64
    Notes string
    name String
    value Double
    notes String
    name string
    value number
    notes string
    name str
    value float
    notes str
    name String
    value Number
    notes String

    ModelCardUserContext, ModelCardUserContextArgs

    DomainId string
    The domain associated with the user.
    UserProfileArn string
    The Amazon Resource Name (ARN) of the user's profile.
    UserProfileName string
    The name of the user's profile.
    DomainId string
    The domain associated with the user.
    UserProfileArn string
    The Amazon Resource Name (ARN) of the user's profile.
    UserProfileName string
    The name of the user's profile.
    domainId String
    The domain associated with the user.
    userProfileArn String
    The Amazon Resource Name (ARN) of the user's profile.
    userProfileName String
    The name of the user's profile.
    domainId string
    The domain associated with the user.
    userProfileArn string
    The Amazon Resource Name (ARN) of the user's profile.
    userProfileName string
    The name of the user's profile.
    domain_id str
    The domain associated with the user.
    user_profile_arn str
    The Amazon Resource Name (ARN) of the user's profile.
    user_profile_name str
    The name of the user's profile.
    domainId String
    The domain associated with the user.
    userProfileArn String
    The Amazon Resource Name (ARN) of the user's profile.
    userProfileName String
    The name of the user's profile.

    Tag, TagArgs

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.102.0 published on Tuesday, Apr 16, 2024 by Pulumi