Skip to content

Update Hub Content

sagemaker_update_hub_content R Documentation

Updates SageMaker hub content (either a Model or Notebook resource)

Description

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.

If you want to update a ModelReference resource in your hub, use the UpdateHubContentResource API instead.

Usage

sagemaker_update_hub_content(HubName, HubContentName, HubContentType,
  HubContentVersion, HubContentDisplayName, HubContentDescription,
  HubContentMarkdown, HubContentSearchKeywords, SupportStatus)

Arguments

HubName

[required] The name of the SageMaker hub that contains the hub content you want to update. You can optionally use the hub ARN instead.

HubContentName

[required] The name of the hub content resource that you want to update.

HubContentType

[required] The content type of the resource that you want to update. Only specify a Model or Notebook resource for this API. To update a ModelReference, use the update_hub_content_reference API instead.

HubContentVersion

[required] 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.

HubContentDisplayName

The display name of the hub content.

HubContentDescription

The description of the hub content.

HubContentMarkdown

A string that provides a description of the hub content. This string can include links, tables, and standard markdown formatting.

HubContentSearchKeywords

The searchable keywords of the hub content.

SupportStatus

Indicates the current status of the hub content resource.

Value

A list with the following syntax:

list(
  HubArn = "string",
  HubContentArn = "string"
)

Request syntax

svc$update_hub_content(
  HubName = "string",
  HubContentName = "string",
  HubContentType = "Model"|"Notebook"|"ModelReference",
  HubContentVersion = "string",
  HubContentDisplayName = "string",
  HubContentDescription = "string",
  HubContentMarkdown = "string",
  HubContentSearchKeywords = list(
    "string"
  ),
  SupportStatus = "Supported"|"Deprecated"|"Restricted"
)