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

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.getModelPackage

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::ModelPackage

    Using getModelPackage

    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 getModelPackage(args: GetModelPackageArgs, opts?: InvokeOptions): Promise<GetModelPackageResult>
function getModelPackageOutput(args: GetModelPackageOutputArgs, opts?: InvokeOptions): Output<GetModelPackageResult>
    def get_model_package(model_package_arn: Optional[str] = None,
                      opts: Optional[InvokeOptions] = None) -> GetModelPackageResult
def get_model_package_output(model_package_arn: Optional[pulumi.Input[str]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetModelPackageResult]
    func LookupModelPackage(ctx *Context, args *LookupModelPackageArgs, opts ...InvokeOption) (*LookupModelPackageResult, error)
func LookupModelPackageOutput(ctx *Context, args *LookupModelPackageOutputArgs, opts ...InvokeOption) LookupModelPackageResultOutput

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

    public static class GetModelPackage 
{
    public static Task<GetModelPackageResult> InvokeAsync(GetModelPackageArgs args, InvokeOptions? opts = null)
    public static Output<GetModelPackageResult> Invoke(GetModelPackageInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetModelPackageResult> getModelPackage(GetModelPackageArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

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

    The following arguments are supported:

    ModelPackageArn string
    The Amazon Resource Name (ARN) of the model package.
    ModelPackageArn string
    The Amazon Resource Name (ARN) of the model package.
    modelPackageArn String
    The Amazon Resource Name (ARN) of the model package.
    modelPackageArn string
    The Amazon Resource Name (ARN) of the model package.
    model_package_arn str
    The Amazon Resource Name (ARN) of the model package.
    modelPackageArn String
    The Amazon Resource Name (ARN) of the model package.

    getModelPackage Result

    The following output properties are available:

    AdditionalInferenceSpecifications List<Pulumi.AwsNative.SageMaker.Outputs.ModelPackageAdditionalInferenceSpecificationDefinition>
    An array of additional Inference Specification objects.
    ApprovalDescription string
    A description provided when the model approval is set.
    CertifyForMarketplace bool
    Whether the model package is to be certified to be listed on AWS Marketplace. For information about listing model packages on AWS Marketplace, see List Your Algorithm or Model Package on AWS Marketplace .
    CreationTime string
    The time that the model package was created.
    CustomerMetadataProperties Pulumi.AwsNative.SageMaker.Outputs.ModelPackageCustomerMetadataProperties
    The metadata properties for the model package.
    LastModifiedTime string
    The last time the model package was modified.
    ModelApprovalStatus Pulumi.AwsNative.SageMaker.ModelPackageModelApprovalStatus
    The approval status of the model. This can be one of the following values.

    • APPROVED - The model is approved
    • REJECTED - The model is rejected.
    • PENDING_MANUAL_APPROVAL - The model is waiting for manual approval.
    ModelPackageArn string
    The Amazon Resource Name (ARN) of the model package.
    ModelPackageName string
    The name of the model.
    ModelPackageStatus Pulumi.AwsNative.SageMaker.ModelPackageStatus
    The status of the model package. This can be one of the following values.

    • PENDING - The model package creation is pending.
    • IN_PROGRESS - The model package is in the process of being created.
    • COMPLETED - The model package was successfully created.
    • FAILED - The model package creation failed.
    • DELETING - The model package is in the process of being deleted.
    ModelPackageStatusDetails Pulumi.AwsNative.SageMaker.Outputs.ModelPackageStatusDetails
    Specifies the validation and image scan statuses of the model package.
    ModelPackageVersion int
    The version number of a versioned model.
    SkipModelValidation Pulumi.AwsNative.SageMaker.ModelPackageSkipModelValidation
    Indicates if you want to skip model validation.
    Tags List<Pulumi.AwsNative.Outputs.Tag>
    An array of key-value pairs to apply to this resource.
    AdditionalInferenceSpecifications []ModelPackageAdditionalInferenceSpecificationDefinition
    An array of additional Inference Specification objects.
    ApprovalDescription string
    A description provided when the model approval is set.
    CertifyForMarketplace bool
    Whether the model package is to be certified to be listed on AWS Marketplace. For information about listing model packages on AWS Marketplace, see List Your Algorithm or Model Package on AWS Marketplace .
    CreationTime string
    The time that the model package was created.
    CustomerMetadataProperties ModelPackageCustomerMetadataProperties
    The metadata properties for the model package.
    LastModifiedTime string
    The last time the model package was modified.
    ModelApprovalStatus ModelPackageModelApprovalStatus
    The approval status of the model. This can be one of the following values.

    • APPROVED - The model is approved
    • REJECTED - The model is rejected.
    • PENDING_MANUAL_APPROVAL - The model is waiting for manual approval.
    ModelPackageArn string
    The Amazon Resource Name (ARN) of the model package.
    ModelPackageName string
    The name of the model.
    ModelPackageStatus ModelPackageStatus
    The status of the model package. This can be one of the following values.

    • PENDING - The model package creation is pending.
    • IN_PROGRESS - The model package is in the process of being created.
    • COMPLETED - The model package was successfully created.
    • FAILED - The model package creation failed.
    • DELETING - The model package is in the process of being deleted.
    ModelPackageStatusDetails ModelPackageStatusDetails
    Specifies the validation and image scan statuses of the model package.
    ModelPackageVersion int
    The version number of a versioned model.
    SkipModelValidation ModelPackageSkipModelValidation
    Indicates if you want to skip model validation.
    Tags Tag
    An array of key-value pairs to apply to this resource.
    additionalInferenceSpecifications List<ModelPackageAdditionalInferenceSpecificationDefinition>
    An array of additional Inference Specification objects.
    approvalDescription String
    A description provided when the model approval is set.
    certifyForMarketplace Boolean
    Whether the model package is to be certified to be listed on AWS Marketplace. For information about listing model packages on AWS Marketplace, see List Your Algorithm or Model Package on AWS Marketplace .
    creationTime String
    The time that the model package was created.
    customerMetadataProperties ModelPackageCustomerMetadataProperties
    The metadata properties for the model package.
    lastModifiedTime String
    The last time the model package was modified.
    modelApprovalStatus ModelPackageModelApprovalStatus
    The approval status of the model. This can be one of the following values.

    • APPROVED - The model is approved
    • REJECTED - The model is rejected.
    • PENDING_MANUAL_APPROVAL - The model is waiting for manual approval.
    modelPackageArn String
    The Amazon Resource Name (ARN) of the model package.
    modelPackageName String
    The name of the model.
    modelPackageStatus ModelPackageStatus
    The status of the model package. This can be one of the following values.

    • PENDING - The model package creation is pending.
    • IN_PROGRESS - The model package is in the process of being created.
    • COMPLETED - The model package was successfully created.
    • FAILED - The model package creation failed.
    • DELETING - The model package is in the process of being deleted.
    modelPackageStatusDetails ModelPackageStatusDetails
    Specifies the validation and image scan statuses of the model package.
    modelPackageVersion Integer
    The version number of a versioned model.
    skipModelValidation ModelPackageSkipModelValidation
    Indicates if you want to skip model validation.
    tags List<Tag>
    An array of key-value pairs to apply to this resource.
    additionalInferenceSpecifications ModelPackageAdditionalInferenceSpecificationDefinition[]
    An array of additional Inference Specification objects.
    approvalDescription string
    A description provided when the model approval is set.
    certifyForMarketplace boolean
    Whether the model package is to be certified to be listed on AWS Marketplace. For information about listing model packages on AWS Marketplace, see List Your Algorithm or Model Package on AWS Marketplace .
    creationTime string
    The time that the model package was created.
    customerMetadataProperties ModelPackageCustomerMetadataProperties
    The metadata properties for the model package.
    lastModifiedTime string
    The last time the model package was modified.
    modelApprovalStatus ModelPackageModelApprovalStatus
    The approval status of the model. This can be one of the following values.

    • APPROVED - The model is approved
    • REJECTED - The model is rejected.
    • PENDING_MANUAL_APPROVAL - The model is waiting for manual approval.
    modelPackageArn string
    The Amazon Resource Name (ARN) of the model package.
    modelPackageName string
    The name of the model.
    modelPackageStatus ModelPackageStatus
    The status of the model package. This can be one of the following values.

    • PENDING - The model package creation is pending.
    • IN_PROGRESS - The model package is in the process of being created.
    • COMPLETED - The model package was successfully created.
    • FAILED - The model package creation failed.
    • DELETING - The model package is in the process of being deleted.
    modelPackageStatusDetails ModelPackageStatusDetails
    Specifies the validation and image scan statuses of the model package.
    modelPackageVersion number
    The version number of a versioned model.
    skipModelValidation ModelPackageSkipModelValidation
    Indicates if you want to skip model validation.
    tags Tag[]
    An array of key-value pairs to apply to this resource.
    additional_inference_specifications Sequence[ModelPackageAdditionalInferenceSpecificationDefinition]
    An array of additional Inference Specification objects.
    approval_description str
    A description provided when the model approval is set.
    certify_for_marketplace bool
    Whether the model package is to be certified to be listed on AWS Marketplace. For information about listing model packages on AWS Marketplace, see List Your Algorithm or Model Package on AWS Marketplace .
    creation_time str
    The time that the model package was created.
    customer_metadata_properties ModelPackageCustomerMetadataProperties
    The metadata properties for the model package.
    last_modified_time str
    The last time the model package was modified.
    model_approval_status ModelPackageModelApprovalStatus
    The approval status of the model. This can be one of the following values.

    • APPROVED - The model is approved
    • REJECTED - The model is rejected.
    • PENDING_MANUAL_APPROVAL - The model is waiting for manual approval.
    model_package_arn str
    The Amazon Resource Name (ARN) of the model package.
    model_package_name str
    The name of the model.
    model_package_status ModelPackageStatus
    The status of the model package. This can be one of the following values.

    • PENDING - The model package creation is pending.
    • IN_PROGRESS - The model package is in the process of being created.
    • COMPLETED - The model package was successfully created.
    • FAILED - The model package creation failed.
    • DELETING - The model package is in the process of being deleted.
    model_package_status_details ModelPackageStatusDetails
    Specifies the validation and image scan statuses of the model package.
    model_package_version int
    The version number of a versioned model.
    skip_model_validation ModelPackageSkipModelValidation
    Indicates if you want to skip model validation.
    tags Sequence[root_Tag]
    An array of key-value pairs to apply to this resource.
    additionalInferenceSpecifications List<Property Map>
    An array of additional Inference Specification objects.
    approvalDescription String
    A description provided when the model approval is set.
    certifyForMarketplace Boolean
    Whether the model package is to be certified to be listed on AWS Marketplace. For information about listing model packages on AWS Marketplace, see List Your Algorithm or Model Package on AWS Marketplace .
    creationTime String
    The time that the model package was created.
    customerMetadataProperties Property Map
    The metadata properties for the model package.
    lastModifiedTime String
    The last time the model package was modified.
    modelApprovalStatus "Approved" | "Rejected" | "PendingManualApproval"
    The approval status of the model. This can be one of the following values.

    • APPROVED - The model is approved
    • REJECTED - The model is rejected.
    • PENDING_MANUAL_APPROVAL - The model is waiting for manual approval.
    modelPackageArn String
    The Amazon Resource Name (ARN) of the model package.
    modelPackageName String
    The name of the model.
    modelPackageStatus "Pending" | "Deleting" | "InProgress" | "Completed" | "Failed"
    The status of the model package. This can be one of the following values.

    • PENDING - The model package creation is pending.
    • IN_PROGRESS - The model package is in the process of being created.
    • COMPLETED - The model package was successfully created.
    • FAILED - The model package creation failed.
    • DELETING - The model package is in the process of being deleted.
    modelPackageStatusDetails Property Map
    Specifies the validation and image scan statuses of the model package.
    modelPackageVersion Number
    The version number of a versioned model.
    skipModelValidation "None" | "All"
    Indicates if you want to skip model validation.
    tags List<Property Map>
    An array of key-value pairs to apply to this resource.

    Supporting Types

    ModelPackageAdditionalInferenceSpecificationDefinition

    Containers List<Pulumi.AwsNative.SageMaker.Inputs.ModelPackageContainerDefinition>
    The Amazon ECR registry path of the Docker image that contains the inference code.
    Name string
    A unique name to identify the additional inference specification. The name must be unique within the list of your additional inference specifications for a particular model package.
    Description string
    A description of the additional Inference specification.
    SupportedContentTypes List<string>
    The supported MIME types for the input data.
    SupportedRealtimeInferenceInstanceTypes List<string>
    A list of the instance types that are used to generate inferences in real-time
    SupportedResponseMimeTypes List<string>
    The supported MIME types for the output data.
    SupportedTransformInstanceTypes List<string>
    A list of the instance types on which a transformation job can be run or on which an endpoint can be deployed.
    Containers []ModelPackageContainerDefinition
    The Amazon ECR registry path of the Docker image that contains the inference code.
    Name string
    A unique name to identify the additional inference specification. The name must be unique within the list of your additional inference specifications for a particular model package.
    Description string
    A description of the additional Inference specification.
    SupportedContentTypes []string
    The supported MIME types for the input data.
    SupportedRealtimeInferenceInstanceTypes []string
    A list of the instance types that are used to generate inferences in real-time
    SupportedResponseMimeTypes []string
    The supported MIME types for the output data.
    SupportedTransformInstanceTypes []string
    A list of the instance types on which a transformation job can be run or on which an endpoint can be deployed.
    containers List<ModelPackageContainerDefinition>
    The Amazon ECR registry path of the Docker image that contains the inference code.
    name String
    A unique name to identify the additional inference specification. The name must be unique within the list of your additional inference specifications for a particular model package.
    description String
    A description of the additional Inference specification.
    supportedContentTypes List<String>
    The supported MIME types for the input data.
    supportedRealtimeInferenceInstanceTypes List<String>
    A list of the instance types that are used to generate inferences in real-time
    supportedResponseMimeTypes List<String>
    The supported MIME types for the output data.
    supportedTransformInstanceTypes List<String>
    A list of the instance types on which a transformation job can be run or on which an endpoint can be deployed.
    containers ModelPackageContainerDefinition[]
    The Amazon ECR registry path of the Docker image that contains the inference code.
    name string
    A unique name to identify the additional inference specification. The name must be unique within the list of your additional inference specifications for a particular model package.
    description string
    A description of the additional Inference specification.
    supportedContentTypes string[]
    The supported MIME types for the input data.
    supportedRealtimeInferenceInstanceTypes string[]
    A list of the instance types that are used to generate inferences in real-time
    supportedResponseMimeTypes string[]
    The supported MIME types for the output data.
    supportedTransformInstanceTypes string[]
    A list of the instance types on which a transformation job can be run or on which an endpoint can be deployed.
    containers Sequence[ModelPackageContainerDefinition]
    The Amazon ECR registry path of the Docker image that contains the inference code.
    name str
    A unique name to identify the additional inference specification. The name must be unique within the list of your additional inference specifications for a particular model package.
    description str
    A description of the additional Inference specification.
    supported_content_types Sequence[str]
    The supported MIME types for the input data.
    supported_realtime_inference_instance_types Sequence[str]
    A list of the instance types that are used to generate inferences in real-time
    supported_response_mime_types Sequence[str]
    The supported MIME types for the output data.
    supported_transform_instance_types Sequence[str]
    A list of the instance types on which a transformation job can be run or on which an endpoint can be deployed.
    containers List<Property Map>
    The Amazon ECR registry path of the Docker image that contains the inference code.
    name String
    A unique name to identify the additional inference specification. The name must be unique within the list of your additional inference specifications for a particular model package.
    description String
    A description of the additional Inference specification.
    supportedContentTypes List<String>
    The supported MIME types for the input data.
    supportedRealtimeInferenceInstanceTypes List<String>
    A list of the instance types that are used to generate inferences in real-time
    supportedResponseMimeTypes List<String>
    The supported MIME types for the output data.
    supportedTransformInstanceTypes List<String>
    A list of the instance types on which a transformation job can be run or on which an endpoint can be deployed.

    ModelPackageContainerDefinition

    Image string
    The Amazon EC2 Container Registry (Amazon ECR) path where inference code is stored.
    ContainerHostname string
    The DNS host name for the Docker container.
    Environment Pulumi.AwsNative.SageMaker.Inputs.ModelPackageEnvironment
    Framework string
    The machine learning framework of the model package container image.
    FrameworkVersion string
    The framework version of the Model Package Container Image.
    ImageDigest string
    An MD5 hash of the training algorithm that identifies the Docker image used for training.
    ModelDataUrl string
    A structure with Model Input details.
    ModelInput Pulumi.AwsNative.SageMaker.Inputs.ModelPackageContainerDefinitionModelInputProperties
    NearestModelName string
    The name of a pre-trained machine learning benchmarked by Amazon SageMaker Inference Recommender model that matches your model.
    Image string
    The Amazon EC2 Container Registry (Amazon ECR) path where inference code is stored.
    ContainerHostname string
    The DNS host name for the Docker container.
    Environment ModelPackageEnvironment
    Framework string
    The machine learning framework of the model package container image.
    FrameworkVersion string
    The framework version of the Model Package Container Image.
    ImageDigest string
    An MD5 hash of the training algorithm that identifies the Docker image used for training.
    ModelDataUrl string
    A structure with Model Input details.
    ModelInput ModelPackageContainerDefinitionModelInputProperties
    NearestModelName string
    The name of a pre-trained machine learning benchmarked by Amazon SageMaker Inference Recommender model that matches your model.
    image String
    The Amazon EC2 Container Registry (Amazon ECR) path where inference code is stored.
    containerHostname String
    The DNS host name for the Docker container.
    environment ModelPackageEnvironment
    framework String
    The machine learning framework of the model package container image.
    frameworkVersion String
    The framework version of the Model Package Container Image.
    imageDigest String
    An MD5 hash of the training algorithm that identifies the Docker image used for training.
    modelDataUrl String
    A structure with Model Input details.
    modelInput ModelPackageContainerDefinitionModelInputProperties
    nearestModelName String
    The name of a pre-trained machine learning benchmarked by Amazon SageMaker Inference Recommender model that matches your model.
    image string
    The Amazon EC2 Container Registry (Amazon ECR) path where inference code is stored.
    containerHostname string
    The DNS host name for the Docker container.
    environment ModelPackageEnvironment
    framework string
    The machine learning framework of the model package container image.
    frameworkVersion string
    The framework version of the Model Package Container Image.
    imageDigest string
    An MD5 hash of the training algorithm that identifies the Docker image used for training.
    modelDataUrl string
    A structure with Model Input details.
    modelInput ModelPackageContainerDefinitionModelInputProperties
    nearestModelName string
    The name of a pre-trained machine learning benchmarked by Amazon SageMaker Inference Recommender model that matches your model.
    image str
    The Amazon EC2 Container Registry (Amazon ECR) path where inference code is stored.
    container_hostname str
    The DNS host name for the Docker container.
    environment ModelPackageEnvironment
    framework str
    The machine learning framework of the model package container image.
    framework_version str
    The framework version of the Model Package Container Image.
    image_digest str
    An MD5 hash of the training algorithm that identifies the Docker image used for training.
    model_data_url str
    A structure with Model Input details.
    model_input ModelPackageContainerDefinitionModelInputProperties
    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
    The Amazon EC2 Container Registry (Amazon ECR) path where inference code is stored.
    containerHostname String
    The DNS host name for the Docker container.
    environment Property Map
    framework String
    The machine learning framework of the model package container image.
    frameworkVersion String
    The framework version of the Model Package Container Image.
    imageDigest String
    An MD5 hash of the training algorithm that identifies the Docker image used for training.
    modelDataUrl String
    A structure with Model Input details.
    modelInput Property Map
    nearestModelName String
    The name of a pre-trained machine learning benchmarked by Amazon SageMaker Inference Recommender model that matches your model.

    ModelPackageContainerDefinitionModelInputProperties

    DataInputConfig string
    The input configuration object for the model.
    DataInputConfig string
    The input configuration object for the model.
    dataInputConfig String
    The input configuration object for the model.
    dataInputConfig string
    The input configuration object for the model.
    data_input_config str
    The input configuration object for the model.
    dataInputConfig String
    The input configuration object for the model.

    ModelPackageModelApprovalStatus

    ModelPackageSkipModelValidation

    ModelPackageStatus

    ModelPackageStatusDetails

    ValidationStatuses []ModelPackageStatusItem
    The validation status of the model package.
    validationStatuses List<ModelPackageStatusItem>
    The validation status of the model package.
    validationStatuses ModelPackageStatusItem[]
    The validation status of the model package.
    validation_statuses Sequence[ModelPackageStatusItem]
    The validation status of the model package.
    validationStatuses List<Property Map>
    The validation status of the model package.

    ModelPackageStatusItem

    Name string
    The name of the model package for which the overall status is being reported.
    Status Pulumi.AwsNative.SageMaker.ModelPackageStatusItemStatus
    The current status.
    FailureReason string
    If the overall status is Failed, the reason for the failure.
    Name string
    The name of the model package for which the overall status is being reported.
    Status ModelPackageStatusItemStatus
    The current status.
    FailureReason string
    If the overall status is Failed, the reason for the failure.
    name String
    The name of the model package for which the overall status is being reported.
    status ModelPackageStatusItemStatus
    The current status.
    failureReason String
    If the overall status is Failed, the reason for the failure.
    name string
    The name of the model package for which the overall status is being reported.
    status ModelPackageStatusItemStatus
    The current status.
    failureReason string
    If the overall status is Failed, the reason for the failure.
    name str
    The name of the model package for which the overall status is being reported.
    status ModelPackageStatusItemStatus
    The current status.
    failure_reason str
    If the overall status is Failed, the reason for the failure.
    name String
    The name of the model package for which the overall status is being reported.
    status "NotStarted" | "Failed" | "InProgress" | "Completed"
    The current status.
    failureReason String
    If the overall status is Failed, the reason for the failure.

    ModelPackageStatusItemStatus

    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