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

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

AWS Native v0.109.0 published on Wednesday, Jun 26, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.sagemaker.getModelCard

Explore with Pulumi AI

aws-native logo

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

AWS Native v0.109.0 published on Wednesday, Jun 26, 2024 by Pulumi
pulumi/pulumi-aws-native

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

    Using getModelCard

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getModelCard(args: GetModelCardArgs, opts?: InvokeOptions): Promise<GetModelCardResult>
function getModelCardOutput(args: GetModelCardOutputArgs, opts?: InvokeOptions): Output<GetModelCardResult>
    def get_model_card(model_card_name: Optional[str] = None,
                   opts: Optional[InvokeOptions] = None) -> GetModelCardResult
def get_model_card_output(model_card_name: Optional[pulumi.Input[str]] = None,
                   opts: Optional[InvokeOptions] = None) -> Output[GetModelCardResult]
    func LookupModelCard(ctx *Context, args *LookupModelCardArgs, opts ...InvokeOption) (*LookupModelCardResult, error)
func LookupModelCardOutput(ctx *Context, args *LookupModelCardOutputArgs, opts ...InvokeOption) LookupModelCardResultOutput

    > Note: This function is named LookupModelCard in the Go SDK.

    public static class GetModelCard 
{
    public static Task<GetModelCardResult> InvokeAsync(GetModelCardArgs args, InvokeOptions? opts = null)
    public static Output<GetModelCardResult> Invoke(GetModelCardInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetModelCardResult> getModelCard(GetModelCardArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: aws-native:sagemaker:getModelCard
  arguments:
    # arguments dictionary

    The following arguments are supported:

    ModelCardName string
    The unique name of the model card.
    ModelCardName string
    The unique name of the model card.
    modelCardName String
    The unique name of the model card.
    modelCardName string
    The unique name of the model card.
    model_card_name str
    The unique name of the model card.
    modelCardName String
    The unique name of the model card.

    getModelCard Result

    The following output properties are available:

    Content Pulumi.AwsNative.SageMaker.Outputs.ModelCardContent
    The content of the model card. Content uses the model card JSON schema .
    CreatedBy Pulumi.AwsNative.SageMaker.Outputs.ModelCardUserContext
    Information about the user who created or modified an experiment, trial, trial component, lineage group, project, or model card.
    CreationTime string
    The date and time the model card was created.
    LastModifiedBy Pulumi.AwsNative.SageMaker.Outputs.ModelCardUserContext
    Information about the user who created or modified an experiment, trial, trial component, lineage group, project, or model card.
    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.
    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.
    ModelCardVersion int
    A version of the model card.
    Tags List<Pulumi.AwsNative.Outputs.Tag>
    Key-value pairs used to manage metadata for model cards.
    Content ModelCardContent
    The content of the model card. Content uses the model card JSON schema .
    CreatedBy ModelCardUserContext
    Information about the user who created or modified an experiment, trial, trial component, lineage group, project, or model card.
    CreationTime string
    The date and time the model card was created.
    LastModifiedBy ModelCardUserContext
    Information about the user who created or modified an experiment, trial, trial component, lineage group, project, or model card.
    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.
    ModelCardStatus ModelCardStatus
    The approval status of the model card within your organization. Different organizations might have different criteria for model card review and approval.
    ModelCardVersion int
    A version of the model card.
    Tags Tag
    Key-value pairs used to manage metadata for model cards.
    content ModelCardContent
    The content of the model card. Content uses the model card JSON schema .
    createdBy ModelCardUserContext
    Information about the user who created or modified an experiment, trial, trial component, lineage group, project, or model card.
    creationTime String
    The date and time the model card was created.
    lastModifiedBy ModelCardUserContext
    Information about the user who created or modified an experiment, trial, trial component, lineage group, project, or model card.
    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.
    modelCardStatus ModelCardStatus
    The approval status of the model card within your organization. Different organizations might have different criteria for model card review and approval.
    modelCardVersion Integer
    A version of the model card.
    tags List<Tag>
    Key-value pairs used to manage metadata for model cards.
    content ModelCardContent
    The content of the model card. Content uses the model card JSON schema .
    createdBy ModelCardUserContext
    Information about the user who created or modified an experiment, trial, trial component, lineage group, project, or model card.
    creationTime string
    The date and time the model card was created.
    lastModifiedBy ModelCardUserContext
    Information about the user who created or modified an experiment, trial, trial component, lineage group, project, or model card.
    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.
    modelCardStatus ModelCardStatus
    The approval status of the model card within your organization. Different organizations might have different criteria for model card review and approval.
    modelCardVersion number
    A version of the model card.
    tags Tag[]
    Key-value pairs used to manage metadata for model cards.
    content ModelCardContent
    The content of the model card. Content uses the model card JSON schema .
    created_by ModelCardUserContext
    Information about the user who created or modified an experiment, trial, trial component, lineage group, project, or model card.
    creation_time str
    The date and time the model card was created.
    last_modified_by ModelCardUserContext
    Information about the user who created or modified an experiment, trial, trial component, lineage group, project, or model card.
    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_status ModelCardStatus
    The approval status of the model card within your organization. Different organizations might have different criteria for model card review and approval.
    model_card_version int
    A version of the model card.
    tags Sequence[root_Tag]
    Key-value pairs used to manage metadata for model cards.
    content Property Map
    The content of the model card. Content uses the model card JSON schema .
    createdBy Property Map
    Information about the user who created or modified an experiment, trial, trial component, lineage group, project, or model card.
    creationTime String
    The date and time the model card was created.
    lastModifiedBy Property Map
    Information about the user who created or modified an experiment, trial, trial component, lineage group, project, or model card.
    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.
    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.
    modelCardVersion Number
    A version of the model card.
    tags List<Property Map>
    Key-value pairs used to manage metadata for model cards.

    Supporting Types

    ModelCardAdditionalInformation

    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

    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

    ModelCardBusinessDetails

    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

    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

    AdditionalInformation ModelCardAdditionalInformation
    Additional information about the model.
    BusinessDetails ModelCardBusinessDetails
    Information about how the model supports business goals.
    EvaluationDetails []ModelCardEvaluationDetail
    An overview about the model's evaluation.
    IntendedUses ModelCardIntendedUses
    The intended usage of the model.
    ModelOverview ModelCardModelOverview
    An overview about the model
    ModelPackageDetails ModelCardModelPackageDetails
    TrainingDetails ModelCardTrainingDetails
    An overview about model training.
    additionalInformation ModelCardAdditionalInformation
    Additional information about the model.
    businessDetails ModelCardBusinessDetails
    Information about how the model supports business goals.
    evaluationDetails List<ModelCardEvaluationDetail>
    An overview about the model's evaluation.
    intendedUses ModelCardIntendedUses
    The intended usage of the model.
    modelOverview ModelCardModelOverview
    An overview about the model
    modelPackageDetails ModelCardModelPackageDetails
    trainingDetails ModelCardTrainingDetails
    An overview about model training.
    additionalInformation ModelCardAdditionalInformation
    Additional information about the model.
    businessDetails ModelCardBusinessDetails
    Information about how the model supports business goals.
    evaluationDetails ModelCardEvaluationDetail[]
    An overview about the model's evaluation.
    intendedUses ModelCardIntendedUses
    The intended usage of the model.
    modelOverview ModelCardModelOverview
    An overview about the model
    modelPackageDetails ModelCardModelPackageDetails
    trainingDetails ModelCardTrainingDetails
    An overview about model training.
    additional_information ModelCardAdditionalInformation
    Additional information about the model.
    business_details ModelCardBusinessDetails
    Information about how the model supports business goals.
    evaluation_details Sequence[ModelCardEvaluationDetail]
    An overview about the model's evaluation.
    intended_uses ModelCardIntendedUses
    The intended usage of the model.
    model_overview ModelCardModelOverview
    An overview about the model
    model_package_details ModelCardModelPackageDetails
    training_details ModelCardTrainingDetails
    An overview about model training.
    additionalInformation Property Map
    Additional information about the model.
    businessDetails Property Map
    Information about how the model supports business goals.
    evaluationDetails List<Property Map>
    An overview about the model's evaluation.
    intendedUses Property Map
    The intended usage of the model.
    modelOverview Property Map
    An overview about the model
    modelPackageDetails Property Map
    trainingDetails Property Map
    An overview about model training.

    ModelCardEvaluationDetail

    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

    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

    ExplanationsForRiskRating string
    An explanation of why your organization categorizes the model with its risk rating.
    FactorsAffectingModelEfficiency string
    Factors affecting model efficacy.
    IntendedUses string
    intended use cases.
    PurposeOfModel string
    Why the model was developed?
    RiskRating Pulumi.AwsNative.SageMaker.ModelCardRiskRating
    Your organization's risk rating. You can specify one the following values as the risk rating:

    • High
    • Medium
    • Low
    • Unknown
    ExplanationsForRiskRating string
    An explanation of why your organization categorizes the model with its risk rating.
    FactorsAffectingModelEfficiency string
    Factors affecting model efficacy.
    IntendedUses string
    intended use cases.
    PurposeOfModel string
    Why the model was developed?
    RiskRating ModelCardRiskRating
    Your organization's risk rating. You can specify one the following values as the risk rating:

    • High
    • Medium
    • Low
    • Unknown
    explanationsForRiskRating String
    An explanation of why your organization categorizes the model with its risk rating.
    factorsAffectingModelEfficiency String
    Factors affecting model efficacy.
    intendedUses String
    intended use cases.
    purposeOfModel String
    Why the model was developed?
    riskRating ModelCardRiskRating
    Your organization's risk rating. You can specify one the following values as the risk rating:

    • High
    • Medium
    • Low
    • Unknown
    explanationsForRiskRating string
    An explanation of why your organization categorizes the model with its risk rating.
    factorsAffectingModelEfficiency string
    Factors affecting model efficacy.
    intendedUses string
    intended use cases.
    purposeOfModel string
    Why the model was developed?
    riskRating ModelCardRiskRating
    Your organization's risk rating. You can specify one the following values as the risk rating:

    • High
    • Medium
    • Low
    • Unknown
    explanations_for_risk_rating str
    An explanation of why your organization categorizes the model with its risk rating.
    factors_affecting_model_efficiency str
    Factors affecting model efficacy.
    intended_uses str
    intended use cases.
    purpose_of_model str
    Why the model was developed?
    risk_rating ModelCardRiskRating
    Your organization's risk rating. You can specify one the following values as the risk rating:

    • High
    • Medium
    • Low
    • Unknown
    explanationsForRiskRating String
    An explanation of why your organization categorizes the model with its risk rating.
    factorsAffectingModelEfficiency String
    Factors affecting model efficacy.
    intendedUses String
    intended use cases.
    purposeOfModel String
    Why the model was developed?
    riskRating "High" | "Medium" | "Low" | "Unknown"
    Your organization's risk rating. You can specify one the following values as the risk rating:

    • High
    • Medium
    • Low
    • Unknown

    ModelCardLinearGraphMetric

    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

    ModelCardMatrixMetric

    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

    ModelCardMetricGroup

    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

    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

    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

    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

    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

    ModelCardModelPackageDetailsModelPackageStatus

    ModelCardObjectiveFunction

    Function Pulumi.AwsNative.SageMaker.Inputs.ModelCardObjectiveFunctionFunctionProperties
    objective function that training job is optimized for.
    Notes string
    Notes about the object function, including other considerations for possible objective functions.
    Function ModelCardObjectiveFunctionFunctionProperties
    objective function that training job is optimized for.
    Notes string
    Notes about the object function, including other considerations for possible objective functions.
    function ModelCardObjectiveFunctionFunctionProperties
    objective function that training job is optimized for.
    notes String
    Notes about the object function, including other considerations for possible objective functions.
    function ModelCardObjectiveFunctionFunctionProperties
    objective function that training job is optimized for.
    notes string
    Notes about the object function, including other considerations for possible objective functions.
    function ModelCardObjectiveFunctionFunctionProperties
    objective function that training job is optimized for.
    notes str
    Notes about the object function, including other considerations for possible objective functions.
    function Property Map
    objective function that training job is optimized for.
    notes String
    Notes about the object function, including other considerations for possible objective functions.

    ModelCardObjectiveFunctionFunctionProperties

    ModelCardObjectiveFunctionFunctionPropertiesFunction

    ModelCardProcessingStatus

    ModelCardRiskRating

    ModelCardSimpleMetric

    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

    ModelCardSourceAlgorithm

    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

    ModelCardTrainingDetails

    ObjectiveFunction Pulumi.AwsNative.SageMaker.Inputs.ModelCardObjectiveFunction
    The function that is optimized during model training.
    TrainingJobDetails Pulumi.AwsNative.SageMaker.Inputs.ModelCardTrainingDetailsTrainingJobDetailsProperties
    Details about any associated training jobs.
    TrainingObservations string
    Any observations about training.
    ObjectiveFunction ModelCardObjectiveFunction
    The function that is optimized during model training.
    TrainingJobDetails ModelCardTrainingDetailsTrainingJobDetailsProperties
    Details about any associated training jobs.
    TrainingObservations string
    Any observations about training.
    objectiveFunction ModelCardObjectiveFunction
    The function that is optimized during model training.
    trainingJobDetails ModelCardTrainingDetailsTrainingJobDetailsProperties
    Details about any associated training jobs.
    trainingObservations String
    Any observations about training.
    objectiveFunction ModelCardObjectiveFunction
    The function that is optimized during model training.
    trainingJobDetails ModelCardTrainingDetailsTrainingJobDetailsProperties
    Details about any associated training jobs.
    trainingObservations string
    Any observations about training.
    objective_function ModelCardObjectiveFunction
    The function that is optimized during model training.
    training_job_details ModelCardTrainingDetailsTrainingJobDetailsProperties
    Details about any associated training jobs.
    training_observations str
    Any observations about training.
    objectiveFunction Property Map
    The function that is optimized during model training.
    trainingJobDetails Property Map
    Details about any associated training jobs.
    trainingObservations String
    Any observations about training.

    ModelCardTrainingDetailsTrainingJobDetailsProperties

    ModelCardTrainingDetailsTrainingJobDetailsPropertiesTrainingEnvironmentProperties

    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

    Name string
    The name of the hyper parameter.
    Value string
    The value specified for the hyper parameter.
    Name string
    The name of the hyper parameter.
    Value string
    The value specified for the hyper parameter.
    name String
    The name of the hyper parameter.
    value String
    The value specified for the hyper parameter.
    name string
    The name of the hyper parameter.
    value string
    The value specified for the hyper parameter.
    name str
    The name of the hyper parameter.
    value str
    The value specified for the hyper parameter.
    name String
    The name of the hyper parameter.
    value String
    The value specified for the hyper parameter.

    ModelCardTrainingMetric

    Name string
    The name of the result from the SageMaker training job.
    Value double
    The value of a result from the SageMaker training job.
    Notes string
    Any additional notes describing the result of the training job.
    Name string
    The name of the result from the SageMaker training job.
    Value float64
    The value of a result from the SageMaker training job.
    Notes string
    Any additional notes describing the result of the training job.
    name String
    The name of the result from the SageMaker training job.
    value Double
    The value of a result from the SageMaker training job.
    notes String
    Any additional notes describing the result of the training job.
    name string
    The name of the result from the SageMaker training job.
    value number
    The value of a result from the SageMaker training job.
    notes string
    Any additional notes describing the result of the training job.
    name str
    The name of the result from the SageMaker training job.
    value float
    The value of a result from the SageMaker training job.
    notes str
    Any additional notes describing the result of the training job.
    name String
    The name of the result from the SageMaker training job.
    value Number
    The value of a result from the SageMaker training job.
    notes String
    Any additional notes describing the result of the training job.

    ModelCardUserContext

    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

    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.109.0 published on Wednesday, Jun 26, 2024 by Pulumi
    pulumi/pulumi-aws-native