:doc:`SageMaker <../../sagemaker>` / Client / describe_hub_content

********************
describe_hub_content
********************



.. py:method:: SageMaker.Client.describe_hub_content(**kwargs)

  

  Describe the content of a hub.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/DescribeHubContent>`_  


  **Request Syntax**
  ::

    response = client.describe_hub_content(
        HubName='string',
        HubContentType='Model'|'Notebook'|'ModelReference'|'DataSet'|'JsonDoc',
        HubContentName='string',
        HubContentVersion='string'
    )
    
  :type HubName: string
  :param HubName: **[REQUIRED]** 

    The name of the hub that contains the content to describe.

    

  
  :type HubContentType: string
  :param HubContentType: **[REQUIRED]** 

    The type of content in the hub.

    

  
  :type HubContentName: string
  :param HubContentName: **[REQUIRED]** 

    The name of the content to describe.

    

  
  :type HubContentVersion: string
  :param HubContentVersion: 

    The version of the content to describe.

    

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'HubContentName': 'string',
          'HubContentArn': 'string',
          'HubContentVersion': 'string',
          'HubContentType': 'Model'|'Notebook'|'ModelReference'|'DataSet'|'JsonDoc',
          'DocumentSchemaVersion': 'string',
          'HubName': 'string',
          'HubArn': 'string',
          'HubContentDisplayName': 'string',
          'HubContentDescription': 'string',
          'HubContentMarkdown': 'string',
          'HubContentDocument': 'string',
          'SageMakerPublicHubContentArn': 'string',
          'ReferenceMinVersion': 'string',
          'SupportStatus': 'Supported'|'Deprecated'|'Restricted',
          'HubContentSearchKeywords': [
              'string',
          ],
          'HubContentDependencies': [
              {
                  'DependencyOriginPath': 'string',
                  'DependencyCopyPath': 'string'
              },
          ],
          'HubContentStatus': 'Available'|'Importing'|'Deleting'|'ImportFailed'|'DeleteFailed'|'PendingImport'|'PendingDelete',
          'FailureReason': 'string',
          'CreationTime': datetime(2015, 1, 1),
          'LastModifiedTime': 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.

        
      

      - **LastModifiedTime** *(datetime) --* 

        The last modified time of the hub content.

        
  
  **Exceptions**
  
  *   :py:class:`SageMaker.Client.exceptions.ResourceNotFound`

  