SageMaker / Client / describe_hub_content

describe_hub_content#

SageMaker.Client.describe_hub_content(**kwargs)#

Describe the content of a hub.

Request Syntax

response = client.describe_hub_content(
    HubName='string',
    HubContentType='Model'|'Notebook'|'ModelReference',
    HubContentName='string',
    HubContentVersion='string'
)

Parameters:

HubName (string) –
[REQUIRED]

The name of the hub that contains the content to describe.
HubContentType (string) –
[REQUIRED]

The type of content in the hub.
HubContentName (string) –
[REQUIRED]

The name of the content to describe.
HubContentVersion (string) – The version of the content to describe.

Return type:

dict

Returns:

Response Syntax

{
    'HubContentName': 'string',
    'HubContentArn': 'string',
    'HubContentVersion': 'string',
    'HubContentType': 'Model'|'Notebook'|'ModelReference',
    'DocumentSchemaVersion': 'string',
    'HubName': 'string',
    'HubArn': 'string',
    'HubContentDisplayName': 'string',
    'HubContentDescription': 'string',
    'HubContentMarkdown': 'string',
    'HubContentDocument': 'string',
    'SageMakerPublicHubContentArn': 'string',
    'ReferenceMinVersion': 'string',
    'SupportStatus': 'Supported'|'Deprecated',
    'HubContentSearchKeywords': [
        'string',
    ],
    'HubContentDependencies': [
        {
            'DependencyOriginPath': 'string',
            'DependencyCopyPath': 'string'
        },
    ],
    'HubContentStatus': 'Available'|'Importing'|'Deleting'|'ImportFailed'|'DeleteFailed',
    'FailureReason': 'string',
    'CreationTime': datetime(2015, 1, 1)
}

Response Structure

(dict) –
- 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 document schema version for the hub content.
- HubName (string) –
  
  The name of the hub that contains the content.
- HubArn (string) –
  
  The Amazon Resource Name (ARN) of the hub that contains the content.
- HubContentDisplayName (string) –
  
  The display name of the hub content.
- HubContentDescription (string) –
  
  A 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 formating.
- HubContentDocument (string) –
  
  The hub content document that describes information about the hub content such as type, associated containers, scripts, and more.
- SageMakerPublicHubContentArn (string) –
  
  The ARN of the public hub content.
- ReferenceMinVersion (string) –
  
  The minimum version of the hub content.
- SupportStatus (string) –
  
  The support status of the hub content.
- HubContentSearchKeywords (list) –
  
  The searchable keywords for the hub content.
  - (string) –
- HubContentDependencies (list) –
  
  The location of any dependencies that the hub content has, such as scripts, model artifacts, datasets, or notebooks.
  - (dict) –
    
    Any dependencies related to hub content, such as scripts, model artifacts, datasets, or notebooks.
    - DependencyOriginPath (string) –
      
      The hub content dependency origin path.
    - DependencyCopyPath (string) –
      
      The hub content dependency copy path.
- HubContentStatus (string) –
  
  The status of the hub content.
- FailureReason (string) –
  
  The failure reason if importing hub content failed.
- CreationTime (datetime) –
  
  The date and time that hub content was created.

Exceptions

SageMaker.Client.exceptions.ResourceNotFound