UpdateHubContentReference
Updates the contents of a SageMaker hub for a ModelReference resource.
A ModelReference allows you to access public SageMaker JumpStart
models from within your private hub.
When using this API, you can update the
MinVersion field for additional flexibility in the model version. You shouldn't update
any additional fields when using this API, because the metadata in your private hub
should match the public JumpStart model's metadata.
Note
If you want to update a Model or Notebook
resource in your hub, use the UpdateHubContent API instead.
For more information about adding model references to your hub, see Add models to a private hub.
Request Syntax
{
"HubContentName": "string",
"HubContentType": "string",
"HubName": "string",
"MinVersion": "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.
- HubContentName
-
The name of the hub content resource that you want to update.
Type: String
Length Constraints: Maximum length of 63.
Pattern:
^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}Required: Yes
- HubContentType
-
The content type of the resource that you want to update. Only specify a
ModelReferenceresource for this API. To update aModelorNotebookresource, use theUpdateHubContentAPI instead.Type: String
Valid Values:
Model | Notebook | ModelReferenceRequired: Yes
- HubName
-
The name of the SageMaker hub that contains the hub content you want to update. You can optionally use the hub ARN instead.
Type: String
Pattern:
^(arn:[a-z0-9-\.]{1,63}:sagemaker:\w+(?:-\w+)+:(\d{12}|aws):hub\/)?[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$Required: Yes
- MinVersion
-
The minimum hub content version of the referenced model that you want to use. The minimum version must be older than the latest available version of the referenced model. To support all versions of a model, set the value to
1.0.0.Type: String
Length Constraints: Minimum length of 5. Maximum length of 14.
Pattern:
^\d{1,4}.\d{1,4}.\d{1,4}$Required: No
Response Syntax
{
"HubArn": "string",
"HubContentArn": "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.
- HubArn
-
The ARN of the private model hub that contains the updated hub content.
Type: String
Length Constraints: Maximum length of 255.
Pattern:
.* - HubContentArn
-
The ARN of the hub content resource that was updated.
Type: String
Length Constraints: Maximum length of 255.
Pattern:
.*
Errors
For information about the errors that are common to all actions, see Common Errors.
- ResourceInUse
-
Resource being accessed is in use.
HTTP Status Code: 400
- ResourceNotFound
-
Resource being access is not found.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
