AWS Native

v0.42.0 published on Wednesday, Nov 23, 2022 by Pulumi

getModelPackage

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

ModelPackageArn string

modelPackageArn String

modelPackageArn string

model_package_arn str

modelPackageArn String

getModelPackage Result

The following output properties are available:

AdditionalInferenceSpecificationDefinition Pulumi.AwsNative.SageMaker.Outputs.ModelPackageAdditionalInferenceSpecificationDefinition
AdditionalInferenceSpecifications List<Pulumi.AwsNative.SageMaker.Outputs.ModelPackageAdditionalInferenceSpecificationDefinition>
AdditionalInferenceSpecificationsToAdd List<Pulumi.AwsNative.SageMaker.Outputs.ModelPackageAdditionalInferenceSpecificationDefinition>
ApprovalDescription string
CertifyForMarketplace bool
CreatedBy Pulumi.AwsNative.SageMaker.Outputs.ModelPackageCreatedBy
CreationTime string
CustomerMetadataProperties Pulumi.AwsNative.SageMaker.Outputs.ModelPackageCustomerMetadataProperties
Environment Pulumi.AwsNative.SageMaker.Outputs.ModelPackageEnvironment
LastModifiedBy Pulumi.AwsNative.SageMaker.Outputs.ModelPackageLastModifiedBy
LastModifiedTime string
ModelApprovalStatus Pulumi.AwsNative.SageMaker.ModelPackageModelApprovalStatus
ModelPackageArn string
ModelPackageName string
ModelPackageStatus Pulumi.AwsNative.SageMaker.ModelPackageStatus
ModelPackageStatusDetails Pulumi.AwsNative.SageMaker.Outputs.ModelPackageStatusDetails
ModelPackageStatusItem Pulumi.AwsNative.SageMaker.Outputs.ModelPackageStatusItem
ModelPackageVersion int
Tags List<Pulumi.AwsNative.SageMaker.Outputs.ModelPackageTag>: An array of key-value pairs to apply to this resource.

AdditionalInferenceSpecificationDefinition ModelPackageAdditionalInferenceSpecificationDefinition
AdditionalInferenceSpecifications []ModelPackageAdditionalInferenceSpecificationDefinition
AdditionalInferenceSpecificationsToAdd []ModelPackageAdditionalInferenceSpecificationDefinition
ApprovalDescription string
CertifyForMarketplace bool
CreatedBy ModelPackageCreatedBy
CreationTime string
CustomerMetadataProperties ModelPackageCustomerMetadataProperties
Environment ModelPackageEnvironment
LastModifiedBy ModelPackageLastModifiedBy
LastModifiedTime string
ModelApprovalStatus ModelPackageModelApprovalStatus
ModelPackageArn string
ModelPackageName string
ModelPackageStatus ModelPackageStatus
ModelPackageStatusDetails ModelPackageStatusDetails
ModelPackageStatusItem ModelPackageStatusItem
ModelPackageVersion int
Tags []ModelPackageTag: An array of key-value pairs to apply to this resource.

additionalInferenceSpecificationDefinition ModelPackageAdditionalInferenceSpecificationDefinition
additionalInferenceSpecifications List<ModelPackageAdditionalInferenceSpecificationDefinition>
additionalInferenceSpecificationsToAdd List<ModelPackageAdditionalInferenceSpecificationDefinition>
approvalDescription String
certifyForMarketplace Boolean
createdBy ModelPackageCreatedBy
creationTime String
customerMetadataProperties ModelPackageCustomerMetadataProperties
environment ModelPackageEnvironment
lastModifiedBy ModelPackageLastModifiedBy
lastModifiedTime String
modelApprovalStatus ModelPackageModelApprovalStatus
modelPackageArn String
modelPackageName String
modelPackageStatus ModelPackageStatus
modelPackageStatusDetails ModelPackageStatusDetails
modelPackageStatusItem ModelPackageStatusItem
modelPackageVersion Integer
tags List<ModelPackageTag>: An array of key-value pairs to apply to this resource.

additionalInferenceSpecificationDefinition ModelPackageAdditionalInferenceSpecificationDefinition
additionalInferenceSpecifications ModelPackageAdditionalInferenceSpecificationDefinition[]
additionalInferenceSpecificationsToAdd ModelPackageAdditionalInferenceSpecificationDefinition[]
approvalDescription string
certifyForMarketplace boolean
createdBy ModelPackageCreatedBy
creationTime string
customerMetadataProperties ModelPackageCustomerMetadataProperties
environment ModelPackageEnvironment
lastModifiedBy ModelPackageLastModifiedBy
lastModifiedTime string
modelApprovalStatus ModelPackageModelApprovalStatus
modelPackageArn string
modelPackageName string
modelPackageStatus ModelPackageStatus
modelPackageStatusDetails ModelPackageStatusDetails
modelPackageStatusItem ModelPackageStatusItem
modelPackageVersion number
tags ModelPackageTag[]: An array of key-value pairs to apply to this resource.

additional_inference_specification_definition ModelPackageAdditionalInferenceSpecificationDefinition
additional_inference_specifications Sequence[ModelPackageAdditionalInferenceSpecificationDefinition]
additional_inference_specifications_to_add Sequence[ModelPackageAdditionalInferenceSpecificationDefinition]
approval_description str
certify_for_marketplace bool
created_by ModelPackageCreatedBy
creation_time str
customer_metadata_properties ModelPackageCustomerMetadataProperties
environment ModelPackageEnvironment
last_modified_by ModelPackageLastModifiedBy
last_modified_time str
model_approval_status ModelPackageModelApprovalStatus
model_package_arn str
model_package_name str
model_package_status ModelPackageStatus
model_package_status_details ModelPackageStatusDetails
model_package_status_item ModelPackageStatusItem
model_package_version int
tags Sequence[ModelPackageTag]: 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.
ProductId string: The AWS Marketplace product ID of the model package.

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.
ProductId string: The AWS Marketplace product ID of the model package.

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.
productId String: The AWS Marketplace product ID of the model package.

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.
productId string: The AWS Marketplace product ID of the model package.

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.
product_id str: The AWS Marketplace product ID of the model package.

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.
productId String: The AWS Marketplace product ID of the model package.

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

ModelPackageStatus

ModelPackageStatusDetails

ValidationStatuses List<Pulumi.AwsNative.SageMaker.Inputs.ModelPackageStatusItem>
ImageScanStatuses List<Pulumi.AwsNative.SageMaker.Inputs.ModelPackageStatusItem>

ValidationStatuses []ModelPackageStatusItem
ImageScanStatuses []ModelPackageStatusItem

validationStatuses List<ModelPackageStatusItem>
imageScanStatuses List<ModelPackageStatusItem>

validationStatuses ModelPackageStatusItem[]
imageScanStatuses ModelPackageStatusItem[]

validation_statuses Sequence[ModelPackageStatusItem]
image_scan_statuses Sequence[ModelPackageStatusItem]

validationStatuses List<Property Map>
imageScanStatuses List<Property Map>

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

ModelPackageTag

Key string: The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
Value string: The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

Key string: The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
Value string: The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

key String: The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
value String: The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

key string: The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
value string: The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

key str: The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
value str: The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

key String: The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
value String: The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

Package Details

Repository: https://github.com/pulumi/pulumi-aws-native
License: Apache-2.0