Updates SageMaker hub content (either a Model or Notebook
resource).
You can update the metadata that describes the resource. In addition to the required request fields, specify at least one of the following fields to update:
-
HubContentDescription -
HubContentDisplayName -
HubContentMarkdown -
HubContentSearchKeywords -
SupportStatus
For more information about hubs, see Private curated hubs for foundation model access control in JumpStart.
Note
If you want to update a ModelReference resource in your hub, use the
UpdateHubContentResource API instead.
Request Syntax
{
"HubContentDescription": "string",
"HubContentDisplayName": "string",
"HubContentMarkdown": "string",
"HubContentName": "string",
"HubContentSearchKeywords": [ "string" ],
"HubContentType": "string",
"HubContentVersion": "string",
"HubName": "string",
"SupportStatus": "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.
- HubContentDescription
-
The description of the hub content.
Type: String
Length Constraints: Maximum length of 1023.
Pattern:
.*Required: No
- HubContentDisplayName
-
The display name of the hub content.
Type: String
Length Constraints: Maximum length of 255.
Pattern:
.*Required: No
- HubContentMarkdown
-
A string that provides a description of the hub content. This string can include links, tables, and standard markdown formatting.
Type: String
Length Constraints: Maximum length of 65535.
Required: No
- 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
- HubContentSearchKeywords
-
The searchable keywords of the hub content.
Type: Array of strings
Array Members: Maximum number of 50 items.
Length Constraints: Maximum length of 255.
Pattern:
^[^A-Z]*$Required: No
- HubContentType
-
The content type of the resource that you want to update. Only specify a
ModelorNotebookresource for this API. To update aModelReference, use theUpdateHubContentReferenceAPI instead.Type: String
Valid Values:
Model | Notebook | ModelReferenceRequired: Yes
- HubContentVersion
-
The hub content version that you want to update. For example, if you have two versions of a resource in your hub, you can update the second version.
Type: String
Length Constraints: Minimum length of 5. Maximum length of 14.
Pattern:
^\d{1,4}.\d{1,4}.\d{1,4}$Required: 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
- SupportStatus
-
Indicates the current status of the hub content resource.
Type: String
Valid Values:
Supported | Deprecated | RestrictedRequired: 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:
