AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the Amazon SageMaker Service UpdateModelPackage API operation.

Syntax

Update-SMModelPackage
-ModelPackageArn <String>
-AdditionalInferenceSpecificationsToAdd <AdditionalInferenceSpecificationDefinition[]>
-ApprovalDescription <String>
-InferenceSpecification_Container <ModelPackageContainerDefinition[]>
-CustomerMetadataProperty <Hashtable>
-CustomerMetadataPropertiesToRemove <String[]>
-ModelApprovalStatus <ModelApprovalStatus>
-ModelCard_ModelCardContent <String>
-ModelCard_ModelCardStatus <ModelCardStatus>
-SourceUri <String>
-ModelLifeCycle_Stage <String>
-ModelLifeCycle_StageDescription <String>
-ModelLifeCycle_StageStatus <String>
-InferenceSpecification_SupportedContentType <String[]>
-InferenceSpecification_SupportedRealtimeInferenceInstanceType <String[]>
-InferenceSpecification_SupportedResponseMIMEType <String[]>
-InferenceSpecification_SupportedTransformInstanceType <String[]>
-ClientToken <String>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>
-ClientConfig <AmazonSageMakerConfig>

Description

Updates a versioned model.

Parameters

-AdditionalInferenceSpecificationsToAdd <AdditionalInferenceSpecificationDefinition[]>
An array of additional Inference Specification objects to be added to the existing array additional Inference Specification. Total number of additional Inference Specifications can not exceed 15. 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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ApprovalDescription <String>
A description for the approval status of the model.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientConfig <AmazonSageMakerConfig>
Amazon.PowerShell.Cmdlets.SM.AmazonSageMakerClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientToken <String>
A unique token that guarantees that the call to this API is idempotent.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-CustomerMetadataPropertiesToRemove <String[]>
The metadata properties associated with the model package versions to remove.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-CustomerMetadataProperty <Hashtable>
The metadata properties associated with the model package versions.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesCustomerMetadataProperties
-Force <SwitchParameter>
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-InferenceSpecification_Container <ModelPackageContainerDefinition[]>
The Amazon ECR registry path of the Docker image that contains the inference code.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesInferenceSpecification_Containers
-InferenceSpecification_SupportedContentType <String[]>
The supported MIME types for the input data.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesInferenceSpecification_SupportedContentTypes
-InferenceSpecification_SupportedRealtimeInferenceInstanceType <String[]>
A list of the instance types that are used to generate inferences in real-time.This parameter is required for unversioned models, and optional for versioned models.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesInferenceSpecification_SupportedRealtimeInferenceInstanceTypes
-InferenceSpecification_SupportedResponseMIMEType <String[]>
The supported MIME types for the output data.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesInferenceSpecification_SupportedResponseMIMETypes
-InferenceSpecification_SupportedTransformInstanceType <String[]>
A list of the instance types on which a transformation job can be run or on which an endpoint can be deployed.This parameter is required for unversioned models, and optional for versioned models.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesInferenceSpecification_SupportedTransformInstanceTypes
-ModelApprovalStatus <ModelApprovalStatus>
The approval status of the model.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ModelCard_ModelCardContent <String>
The content of the model card. The content must follow the schema described in Model Package Model Card Schema.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ModelCard_ModelCardStatus <ModelCardStatus>
The approval status of the model card within your organization. Different organizations might have different criteria for model card review and approval.
  • Draft: The model card is a work in progress.
  • PendingReview: The model card is pending review.
  • Approved: The model card is approved.
  • Archived: The model card is archived. No more updates can be made to the model card content. If you try to update the model card content, you will receive the message Model Card is in Archived state.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ModelLifeCycle_Stage <String>
The current stage in the model life cycle.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ModelLifeCycle_StageDescription <String>
Describes the stage related details.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ModelLifeCycle_StageStatus <String>
The current status of a stage in model life cycle.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ModelPackageArn <String>
The Amazon Resource Name (ARN) of the model package.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-PassThru <SwitchParameter>
Changes the cmdlet behavior to return the value passed to the ModelPackageArn parameter. The -PassThru parameter is deprecated, use -Select '^ModelPackageArn' instead. This parameter will be removed in a future version.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is 'ModelPackageArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.UpdateModelPackageResponse). Specifying the name of a property of type Amazon.SageMaker.Model.UpdateModelPackageResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SourceUri <String>
The URI of the source for the model package.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

System.String or Amazon.SageMaker.Model.UpdateModelPackageResponse
This cmdlet returns a System.String object. The service call response (type Amazon.SageMaker.Model.UpdateModelPackageResponse) can be returned by specifying '-Select *'.
Developer Guide
Service API Reference
AWS Tools for PowerShell User Guide

Supported Version

AWS Tools for PowerShell: 2.x.y.z