SageMaker / Client / import_hub_content

import_hub_content#

SageMaker.Client.import_hub_content(**kwargs)#

Import hub content.

Note

Hub APIs are only callable through SageMaker Studio.

See also: AWS API Documentation

Request Syntax

response = client.import_hub_content(
    HubContentName='string',
    HubContentVersion='string',
    HubContentType='Model'|'Notebook',
    DocumentSchemaVersion='string',
    HubName='string',
    HubContentDisplayName='string',
    HubContentDescription='string',
    HubContentMarkdown='string',
    HubContentDocument='string',
    HubContentSearchKeywords=[
        'string',
    ],
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
Parameters:

  • HubContentName (string) –

    [REQUIRED]

    The name of the hub content to import.

  • HubContentVersion (string) – The version of the hub content to import.

  • HubContentType (string) –

    [REQUIRED]

    The type of hub content to import.

  • DocumentSchemaVersion (string) –

    [REQUIRED]

    The version of the hub content schema to import.

  • HubName (string) –

    [REQUIRED]

    The name of the hub to import content into.

  • HubContentDisplayName (string) – The display name of the hub content to import.

  • HubContentDescription (string) – A description of the hub content to import.

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

  • HubContentDocument (string) –

    [REQUIRED]

    The hub content document that describes information about the hub content such as type, associated containers, scripts, and more.

  • HubContentSearchKeywords (list) –

    The searchable keywords of the hub content.

    • (string) –

  • Tags (list) –

    Any tags associated with the hub content.

    • (dict) –

      A tag object that consists of a key and an optional value, used to manage metadata for SageMaker Amazon Web Services resources.

      You can add tags to notebook instances, training jobs, hyperparameter tuning jobs, batch transform jobs, models, labeling jobs, work teams, endpoint configurations, and endpoints. For more information on adding tags to SageMaker resources, see AddTags.

      For more information on adding metadata to your Amazon Web Services resources with tagging, see Tagging Amazon Web Services resources. For advice on best practices for managing Amazon Web Services resources with tagging, see Tagging Best Practices: Implement an Effective Amazon Web Services Resource Tagging Strategy.

      • Key (string) – [REQUIRED]

        The tag key. Tag keys must be unique per resource.

      • Value (string) – [REQUIRED]

        The tag value.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

  • (dict) –

    • HubArn (string) –

      The ARN of the hub that the content was imported into.

    • HubContentArn (string) –

      The ARN of the hub content that was imported.

Exceptions

  • SageMaker.Client.exceptions.ResourceInUse

  • SageMaker.Client.exceptions.ResourceLimitExceeded

  • SageMaker.Client.exceptions.ResourceNotFound