CreateModelPackageInput ¶

class CreateModelPackageInput(TypedDict, closed=True):
    model_package_name: NotRequired["capo_sagemaker.types.entity_name.EntityName"]
    """<p>The name of the model package. The name must have 1 to 63 characters. Valid characters are a-z, A-Z, 0-9, and - (hyphen).</p> <p>This parameter is required for unversioned models. It is not applicable to versioned models.</p>"""
    model_package_group_name: NotRequired["capo_sagemaker.types.arn_or_name.ArnOrName"]
    """<p>The name or Amazon Resource Name (ARN) of the model package group that this model version belongs to.</p> <p>This parameter is required for versioned models, and does not apply to unversioned models.</p>"""
    model_package_description: NotRequired[
        "capo_sagemaker.types.entity_description.EntityDescription"
    ]
    """<p>A description of the model package.</p>"""
    model_package_registration_type: NotRequired[
        "capo_sagemaker.types.model_package_registration_type.ModelPackageRegistrationType"
    ]
    """<p> The package registration type of the model package input. </p>"""
    inference_specification: NotRequired[
        "capo_sagemaker.types.inference_specification.InferenceSpecification"
    ]
    """<p>Specifies details about inference jobs that you can run with models based on this model package, including the following information:</p> <ul> <li> <p>The Amazon ECR paths of containers that contain the inference code and model artifacts.</p> </li> <li> <p>The instance types that the model package supports for transform jobs and real-time endpoints used for inference.</p> </li> <li> <p>The input and output content formats that the model package supports for inference.</p> </li> </ul>"""
    validation_specification: NotRequired[
        "capo_sagemaker.types.model_package_validation_specification.ModelPackageValidationSpecification"
    ]
    """<p>Specifies configurations for one or more transform jobs that SageMaker runs to test the model package.</p>"""
    source_algorithm_specification: NotRequired[
        "capo_sagemaker.types.source_algorithm_specification.SourceAlgorithmSpecification"
    ]
    """<p>Details about the algorithm that was used to create the model package.</p>"""
    certify_for_marketplace: NotRequired[
        "capo_sagemaker.types.certify_for_marketplace.CertifyForMarketplace"
    ]
    """<p>Whether to certify the model package for listing on Amazon Web Services Marketplace.</p> <p>This parameter is optional for unversioned models, and does not apply to versioned models.</p>"""
    tags: NotRequired["capo_sagemaker.types.tag_list.TagList"]
    """<p>A list of key value pairs associated with the model. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services resources</a> in the <i>Amazon Web Services General Reference Guide</i>.</p> <p>If you supply <code>ModelPackageGroupName</code>, your model package belongs to the model group you specify and uses the tags associated with the model group. In this case, you cannot supply a <code>tag</code> argument. </p>"""
    model_approval_status: NotRequired[
        "capo_sagemaker.types.model_approval_status.ModelApprovalStatus"
    ]
    """<p>Whether the model is approved for deployment.</p> <p>This parameter is optional for versioned models, and does not apply to unversioned models.</p> <p>For versioned models, the value of this parameter must be set to <code>Approved</code> to deploy the model.</p>"""
    metadata_properties: NotRequired[
        "capo_sagemaker.types.metadata_properties.MetadataProperties"
    ]
    model_metrics: NotRequired["capo_sagemaker.types.model_metrics.ModelMetrics"]
    """<p>A structure that contains model metrics reports.</p>"""
    client_token: NotRequired["capo_sagemaker.types.client_token.ClientToken"]
    """<p>A unique token that guarantees that the call to this API is idempotent.</p>"""
    domain: NotRequired["capo_sagemaker.types.string.String"]
    """<p>The machine learning domain of your model package and its components. Common machine learning domains include computer vision and natural language processing.</p>"""
    task: NotRequired["capo_sagemaker.types.string.String"]
    """<p>The machine learning task your model package accomplishes. Common machine learning tasks include object detection and image classification. The following tasks are supported by Inference Recommender: <code>"IMAGE_CLASSIFICATION"</code> | <code>"OBJECT_DETECTION"</code> | <code>"TEXT_GENERATION"</code> |<code>"IMAGE_SEGMENTATION"</code> | <code>"FILL_MASK"</code> | <code>"CLASSIFICATION"</code> | <code>"REGRESSION"</code> | <code>"OTHER"</code>.</p> <p>Specify "OTHER" if none of the tasks listed fit your use case.</p>"""
    sample_payload_url: NotRequired["capo_sagemaker.types.s3_uri.S3Uri"]
    """<p>The Amazon Simple Storage Service (Amazon S3) path where the sample payload is stored. This path must point to a single gzip compressed tar archive (.tar.gz suffix). This archive can hold multiple files that are all equally used in the load test. Each file in the archive must satisfy the size constraints of the <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_runtime_InvokeEndpoint.html#API_runtime_InvokeEndpoint_RequestSyntax">InvokeEndpoint</a> call.</p>"""
    customer_metadata_properties: NotRequired[
        "capo_sagemaker.types.customer_metadata_map.CustomerMetadataMap"
    ]
    """<p>The metadata properties associated with the model package versions.</p>"""
    drift_check_baselines: NotRequired[
        "capo_sagemaker.types.drift_check_baselines.DriftCheckBaselines"
    ]
    """<p>Represents the drift check baselines that can be used when the model monitor is set using the model package. For more information, see the topic on <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/pipelines-quality-clarify-baseline-lifecycle.html#pipelines-quality-clarify-baseline-drift-detection">Drift Detection against Previous Baselines in SageMaker Pipelines</a> in the <i>Amazon SageMaker Developer Guide</i>. </p>"""
    additional_inference_specifications: NotRequired[
        "capo_sagemaker.types.additional_inference_specifications.AdditionalInferenceSpecifications"
    ]
    """<p>An array of additional Inference Specification objects. Each additional Inference Specification specifies artifacts based on this model package that can be used on inference endpoints. Generally used with SageMaker Neo to store the compiled artifacts. </p>"""
    skip_model_validation: NotRequired[
        "capo_sagemaker.types.skip_model_validation.SkipModelValidation"
    ]
    """<p>Indicates if you want to skip model validation.</p>"""
    source_uri: NotRequired[
        "capo_sagemaker.types.model_package_source_uri.ModelPackageSourceUri"
    ]
    """<p>The URI of the source for the model package. If you want to clone a model package, set it to the model package Amazon Resource Name (ARN). If you want to register a model, set it to the model ARN.</p>"""
    security_config: NotRequired[
        "capo_sagemaker.types.model_package_security_config.ModelPackageSecurityConfig"
    ]
    """<p>The KMS Key ID (<code>KMSKeyId</code>) used for encryption of model package information.</p>"""
    model_card: NotRequired[
        "capo_sagemaker.types.model_package_model_card.ModelPackageModelCard"
    ]
    """<p>The model card associated with the model package. Since <code>ModelPackageModelCard</code> is tied to a model package, it is a specific usage of a model card and its schema is simplified compared to the schema of <code>ModelCard</code>. The <code>ModelPackageModelCard</code> schema does not include <code>model_package_details</code>, and <code>model_overview</code> is composed of the <code>model_creator</code> and <code>model_artifact</code> properties. For more information about the model package model card schema, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/model-registry-details.html#model-card-schema">Model package model card schema</a>. For more information about the model card associated with the model package, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/model-registry-details.html">View the Details of a Model Version</a>.</p>"""
    model_life_cycle: NotRequired[
        "capo_sagemaker.types.model_life_cycle.ModelLifeCycle"
    ]
    """<p> A structure describing the current state of the model in its life cycle. </p>"""
    managed_storage_type: NotRequired[
        "capo_sagemaker.types.managed_storage_type.ManagedStorageType"
    ]
    """<p>The storage type of the model package.</p>"""