:doc:`DataZone <../../datazone>` / Client / get_listing

***********
get_listing
***********



.. py:method:: DataZone.Client.get_listing(**kwargs)

  

  Gets a listing (a record of an asset at a given time). If you specify a listing version, only details that are specific to that version are returned.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/datazone-2018-05-10/GetListing>`_  


  **Request Syntax**
  ::

    response = client.get_listing(
        domainIdentifier='string',
        identifier='string',
        listingRevision='string'
    )
    
  :type domainIdentifier: string
  :param domainIdentifier: **[REQUIRED]** 

    The ID of the Amazon DataZone domain.

    

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

    The ID of the listing.

    

  
  :type listingRevision: string
  :param listingRevision: 

    The revision of the listing.

    

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

    
    ::

      {
          'domainId': 'string',
          'id': 'string',
          'listingRevision': 'string',
          'createdAt': datetime(2015, 1, 1),
          'updatedAt': datetime(2015, 1, 1),
          'createdBy': 'string',
          'updatedBy': 'string',
          'item': {
              'assetListing': {
                  'assetId': 'string',
                  'assetRevision': 'string',
                  'assetType': 'string',
                  'createdAt': datetime(2015, 1, 1),
                  'forms': 'string',
                  'latestTimeSeriesDataPointForms': [
                      {
                          'formName': 'string',
                          'typeIdentifier': 'string',
                          'typeRevision': 'string',
                          'timestamp': datetime(2015, 1, 1),
                          'contentSummary': 'string',
                          'id': 'string'
                      },
                  ],
                  'glossaryTerms': [
                      {
                          'name': 'string',
                          'shortDescription': 'string'
                      },
                  ],
                  'governedGlossaryTerms': [
                      {
                          'name': 'string',
                          'shortDescription': 'string'
                      },
                  ],
                  'owningProjectId': 'string'
              },
              'dataProductListing': {
                  'dataProductId': 'string',
                  'dataProductRevision': 'string',
                  'createdAt': datetime(2015, 1, 1),
                  'forms': 'string',
                  'glossaryTerms': [
                      {
                          'name': 'string',
                          'shortDescription': 'string'
                      },
                  ],
                  'owningProjectId': 'string',
                  'items': [
                      {
                          'listingId': 'string',
                          'listingRevision': 'string',
                          'glossaryTerms': [
                              {
                                  'name': 'string',
                                  'shortDescription': 'string'
                              },
                          ]
                      },
                  ]
              }
          },
          'name': 'string',
          'description': 'string',
          'status': 'CREATING'|'ACTIVE'|'INACTIVE'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **domainId** *(string) --* 

        The ID of the Amazon DataZone domain.

        
      

      - **id** *(string) --* 

        The ID of the listing.

        
      

      - **listingRevision** *(string) --* 

        The revision of a listing.

        
      

      - **createdAt** *(datetime) --* 

        The timestamp of when the listing was created.

        
      

      - **updatedAt** *(datetime) --* 

        The timestamp of when the listing was updated.

        
      

      - **createdBy** *(string) --* 

        The Amazon DataZone user who created the listing.

        
      

      - **updatedBy** *(string) --* 

        The Amazon DataZone user who updated the listing.

        
      

      - **item** *(dict) --* 

        The details of a listing.

        .. note::    This is a Tagged Union structure. Only one of the     following top level keys will be set: ``assetListing``, ``dataProductListing``.     If a client receives an unknown member it will     set ``SDK_UNKNOWN_MEMBER`` as the top level key,     which maps to the name or tag of the unknown     member. The structure of ``SDK_UNKNOWN_MEMBER`` is     as follows::

                'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}


      
        

        - **assetListing** *(dict) --* 

          An asset published in an Amazon DataZone catalog.

          
          

          - **assetId** *(string) --* 

            The identifier of an asset published in an Amazon DataZone catalog.

            
          

          - **assetRevision** *(string) --* 

            The revision of an asset published in an Amazon DataZone catalog.

            
          

          - **assetType** *(string) --* 

            The type of an asset published in an Amazon DataZone catalog.

            
          

          - **createdAt** *(datetime) --* 

            The timestamp of when an asset published in an Amazon DataZone catalog was created.

            
          

          - **forms** *(string) --* 

            The metadata forms attached to an asset published in an Amazon DataZone catalog.

            
          

          - **latestTimeSeriesDataPointForms** *(list) --* 

            The latest time series data points forms included in the additional attributes of an asset.

            
            

            - *(dict) --* 

              The summary of the time series data points form.

              
              

              - **formName** *(string) --* 

                The name of the time series data points summary form.

                
              

              - **typeIdentifier** *(string) --* 

                The type ID of the time series data points summary form.

                
              

              - **typeRevision** *(string) --* 

                The type revision of the time series data points summary form.

                
              

              - **timestamp** *(datetime) --* 

                The timestamp of the time series data points summary form.

                
              

              - **contentSummary** *(string) --* 

                The content of the summary of the time series data points form.

                
              

              - **id** *(string) --* 

                The ID of the time series data points summary form.

                
          
        
          

          - **glossaryTerms** *(list) --* 

            The glossary terms attached to an asset published in an Amazon DataZone catalog.

            
            

            - *(dict) --* 

              Details of a glossary term attached to the inventory asset.

              
              

              - **name** *(string) --* 

                The name of a glossary term attached to the inventory asset.

                
              

              - **shortDescription** *(string) --* 

                The shoft description of a glossary term attached to the inventory asset.

                
          
        
          

          - **governedGlossaryTerms** *(list) --* 

            The restricted glossary terms associated with an asset.

            
            

            - *(dict) --* 

              Details of a glossary term attached to the inventory asset.

              
              

              - **name** *(string) --* 

                The name of a glossary term attached to the inventory asset.

                
              

              - **shortDescription** *(string) --* 

                The shoft description of a glossary term attached to the inventory asset.

                
          
        
          

          - **owningProjectId** *(string) --* 

            The identifier of the project where an asset published in an Amazon DataZone catalog exists.

            
      
        

        - **dataProductListing** *(dict) --* 

          The data product listing.

          
          

          - **dataProductId** *(string) --* 

            The ID of the data product listing.

            
          

          - **dataProductRevision** *(string) --* 

            The revision of the data product listing.

            
          

          - **createdAt** *(datetime) --* 

            The timestamp at which the data product listing was created.

            
          

          - **forms** *(string) --* 

            The metadata forms of the data product listing.

            
          

          - **glossaryTerms** *(list) --* 

            The glossary terms of the data product listing.

            
            

            - *(dict) --* 

              Details of a glossary term attached to the inventory asset.

              
              

              - **name** *(string) --* 

                The name of a glossary term attached to the inventory asset.

                
              

              - **shortDescription** *(string) --* 

                The shoft description of a glossary term attached to the inventory asset.

                
          
        
          

          - **owningProjectId** *(string) --* 

            The ID of the owning project of the data product listing.

            
          

          - **items** *(list) --* 

            The data assets of the data product listing.

            
            

            - *(dict) --* 

              The summary of the listing of the data product.

              
              

              - **listingId** *(string) --* 

                The ID of the data product listing.

                
              

              - **listingRevision** *(string) --* 

                The revision of the data product listing.

                
              

              - **glossaryTerms** *(list) --* 

                The glossary terms of the data product.

                
                

                - *(dict) --* 

                  Details of a glossary term attached to the inventory asset.

                  
                  

                  - **name** *(string) --* 

                    The name of a glossary term attached to the inventory asset.

                    
                  

                  - **shortDescription** *(string) --* 

                    The shoft description of a glossary term attached to the inventory asset.

                    
              
            
          
        
      
    
      

      - **name** *(string) --* 

        The name of the listing.

        
      

      - **description** *(string) --* 

        The description of the listing.

        
      

      - **status** *(string) --* 

        The status of the listing.

        
  
  **Exceptions**
  
  *   :py:class:`DataZone.Client.exceptions.InternalServerException`

  
  *   :py:class:`DataZone.Client.exceptions.ResourceNotFoundException`

  
  *   :py:class:`DataZone.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`DataZone.Client.exceptions.ThrottlingException`

  
  *   :py:class:`DataZone.Client.exceptions.ValidationException`

  
  *   :py:class:`DataZone.Client.exceptions.UnauthorizedException`

  