DataZone / Client / get_listing

get_listing#

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

Request Syntax

response = client.get_listing(
    domainIdentifier='string',
    identifier='string',
    listingRevision='string'
)
Parameters:

  • domainIdentifier (string) –

    [REQUIRED]

    The ID of the Amazon DataZone domain.

  • identifier (string) –

    [REQUIRED]

    The ID of the listing.

  • listingRevision (string) – The revision of the listing.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

  • (dict) –

    • createdAt (datetime) –

      The timestamp of when the listing was created.

    • createdBy (string) –

      The Amazon DataZone user who created the listing.

    • description (string) –

      The description of the listing.

    • domainId (string) –

      The ID of the Amazon DataZone domain.

    • id (string) –

      The ID of 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.

        • 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.

        • 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.

            • contentSummary (string) –

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

            • formName (string) –

              The name of the time series data points summary form.

            • id (string) –

              The ID of the time series data points summary form.

            • timestamp (datetime) –

              The timestamp 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.

        • owningProjectId (string) –

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

      • dataProductListing (dict) –

        The data product listing.

        • createdAt (datetime) –

          The timestamp at which the data product listing was created.

        • dataProductId (string) –

          The ID of the data product listing.

        • dataProductRevision (string) –

          The revision of the data product listing.

        • 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.

        • items (list) –

          The data assets of the data product listing.

          • (dict) –

            The summary of the listing of the data product.

            • 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.

            • listingId (string) –

              The ID of the data product listing.

            • listingRevision (string) –

              The revision of the data product listing.

        • owningProjectId (string) –

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

    • listingRevision (string) –

      The revision of a listing.

    • name (string) –

      The name of the listing.

    • status (string) –

      The status of the listing.

    • updatedAt (datetime) –

      The timestamp of when the listing was updated.

    • updatedBy (string) –

      The Amazon DataZone user who updated the listing.

Exceptions