Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

UpdateModelPackage

Updates a versioned model.

Request Syntax


{
   "AdditionalInferenceSpecificationsToAdd": [ 
      { 
         "Containers": [ 
            { 
               "AdditionalS3DataSource": { 
                  "CompressionType": "string",
                  "S3DataType": "string",
                  "S3Uri": "string"
               },
               "ContainerHostname": "string",
               "Environment": { 
                  "string" : "string" 
               },
               "Framework": "string",
               "FrameworkVersion": "string",
               "Image": "string",
               "ImageDigest": "string",
               "ModelDataUrl": "string",
               "ModelInput": { 
                  "DataInputConfig": "string"
               },
               "NearestModelName": "string",
               "ProductId": "string"
            }
         ],
         "Description": "string",
         "Name": "string",
         "SupportedContentTypes": [ "string" ],
         "SupportedRealtimeInferenceInstanceTypes": [ "string" ],
         "SupportedResponseMIMETypes": [ "string" ],
         "SupportedTransformInstanceTypes": [ "string" ]
      }
   ],
   "ApprovalDescription": "string",
   "CustomerMetadataProperties": { 
      "string" : "string" 
   },
   "CustomerMetadataPropertiesToRemove": [ "string" ],
   "ModelApprovalStatus": "string",
   "ModelPackageArn": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

AdditionalInferenceSpecificationsToAdd

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.

Type: Array of AdditionalInferenceSpecificationDefinition objects

Array Members: Minimum number of 1 item. Maximum number of 15 items.

Required: No

ApprovalDescription

A description for the approval status of the model.

Type: String

Length Constraints: Maximum length of 1024.

Pattern: .*

Required: No

CustomerMetadataProperties

The metadata properties associated with the model package versions.

Type: String to string map

Map Entries: Maximum number of 50 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Key Pattern: ^([\p{L}\p{Z}\p{N}_.:\/=+\-@]*)${1,128}

Value Length Constraints: Minimum length of 1. Maximum length of 256.

Value Pattern: ^([\p{L}\p{Z}\p{N}_.:\/=+\-@]*)${1,256}

Required: No

CustomerMetadataPropertiesToRemove

The metadata properties associated with the model package versions to remove.

Type: Array of strings

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: ^([\p{L}\p{Z}\p{N}_.:\/=+\-@]*)${1,128}

Required: No

ModelApprovalStatus

The approval status of the model.

Type: String

Valid Values: Approved | Rejected | PendingManualApproval

Required: No

ModelPackageArn

The Amazon Resource Name (ARN) of the model package.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Pattern: ^arn:aws(-cn|-us-gov)?:sagemaker:[a-z0-9\-]{9,16}:[0-9]{12}:model-package/[\S]{1,2048}$

Required: Yes

Response Syntax


{
   "ModelPackageArn": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

ModelPackageArn

The Amazon Resource Name (ARN) of the model.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Pattern: ^arn:aws(-cn|-us-gov)?:sagemaker:[a-z0-9\-]{9,16}:[0-9]{12}:model-package/[\S]{1,2048}$

Errors

For information about the errors that are common to all actions, see Common Errors.