SageMaker / Client / update_hub_content

update_hub_content#

SageMaker.Client.update_hub_content(**kwargs)#

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.

See also: AWS API Documentation

Request Syntax

response = client.update_hub_content(
    HubName='string',
    HubContentName='string',
    HubContentType='Model'|'Notebook'|'ModelReference',
    HubContentVersion='string',
    HubContentDisplayName='string',
    HubContentDescription='string',
    HubContentMarkdown='string',
    HubContentSearchKeywords=[
        'string',
    ],
    SupportStatus='Supported'|'Deprecated'|'Restricted'
)
Parameters:

  • HubName (string) –

    [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 (string) –

    [REQUIRED]

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

  • HubContentType (string) –

    [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 UpdateHubContentReference API instead.

  • HubContentVersion (string) –

    [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 (string) – The display name of the hub content.

  • HubContentDescription (string) – The description of the hub content.

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

  • HubContentSearchKeywords (list) –

    The searchable keywords of the hub content.

    • (string) –

  • SupportStatus (string) – Indicates the current status of the hub content resource.

Return type:

dict

Returns:

Response Syntax

{
    'HubArn': 'string',
    'HubContentArn': 'string'
}

Response Structure

  • (dict) –

    • HubArn (string) –

      The ARN of the private model hub that contains the updated hub content.

    • HubContentArn (string) –

      The ARN of the hub content resource that was updated.

Exceptions