list_hub_contents

SageMaker.Client.list_hub_contents(**kwargs)

List the contents of a hub.

Note

Hub APIs are only callable through SageMaker Studio.

See also: AWS API Documentation

Request Syntax

response = client.list_hub_contents(
    HubName='string',
    HubContentType='Model'|'Notebook',
    NameContains='string',
    MaxSchemaVersion='string',
    CreationTimeBefore=datetime(2015, 1, 1),
    CreationTimeAfter=datetime(2015, 1, 1),
    SortBy='HubContentName'|'CreationTime'|'HubContentStatus',
    SortOrder='Ascending'|'Descending',
    MaxResults=123,
    NextToken='string'
)

Parameters

• HubName (string) --

  [REQUIRED]

  The name of the hub to list the contents of.

• HubContentType (string) --

  [REQUIRED]

  The type of hub content to list.

• NameContains (string) -- Only list hub content if the name contains the specified string.
• MaxSchemaVersion (string) -- The upper bound of the hub content schema verion.
• CreationTimeBefore (datetime) -- Only list hub content that was created before the time specified.
• CreationTimeAfter (datetime) -- Only list hub content that was created after the time specified.
• SortBy (string) -- Sort hub content versions by either name or creation time.
• SortOrder (string) -- Sort hubs by ascending or descending order.
• MaxResults (integer) -- The maximum amount of hub content to list.
• NextToken (string) -- If the response to a previous ListHubContents request was truncated, the response includes a NextToken . To retrieve the next set of hub content, use the token in the next request.

Return type

dict

Returns

Response Syntax

{
    'HubContentSummaries': [
        {
            'HubContentName': 'string',
            'HubContentArn': 'string',
            'HubContentVersion': 'string',
            'HubContentType': 'Model'|'Notebook',
            'DocumentSchemaVersion': 'string',
            'HubContentDisplayName': 'string',
            'HubContentDescription': 'string',
            'HubContentSearchKeywords': [
                'string',
            ],
            'HubContentStatus': 'Available'|'Importing'|'Deleting'|'ImportFailed'|'DeleteFailed',
            'CreationTime': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) --

  • HubContentSummaries (list) --

    The summaries of the listed hub content.

    • (dict) --

      Information about hub content.

      • HubContentName (string) --

        The name of the hub content.

      • HubContentArn (string) --

        The Amazon Resource Name (ARN) of the hub content.

      • HubContentVersion (string) --

        The version of the hub content.

      • HubContentType (string) --

        The type of hub content.

      • DocumentSchemaVersion (string) --

        The version of the hub content document schema.

      • HubContentDisplayName (string) --

        The display name of the hub content.

      • HubContentDescription (string) --

        A description of the hub content.

      • HubContentSearchKeywords (list) --

        The searchable keywords for the hub content.

        • (string) --

      • HubContentStatus (string) --

        The status of the hub content.

      • CreationTime (datetime) --

        The date and time that the hub content was created.

  • NextToken (string) --

    If the response is truncated, SageMaker returns this token. To retrieve the next set of hub content, use it in the subsequent request.

Exceptions

• SageMaker.Client.exceptions.ResourceNotFound