DataZone / Client / search_listings

search_listings

DataZone.Client.search_listings(**kwargs)

Searches listings in Amazon DataZone.

See also: AWS API Documentation

Request Syntax

response = client.search_listings(
    additionalAttributes=[
        'FORMS',
    ],
    domainIdentifier='string',
    filters={
        'and': [
            {'... recursive ...'},
        ],
        'filter': {
            'attribute': 'string',
            'value': 'string'
        },
        'or': [
            {'... recursive ...'},
        ]
    },
    maxResults=123,
    nextToken='string',
    searchIn=[
        {
            'attribute': 'string'
        },
    ],
    searchText='string',
    sort={
        'attribute': 'string',
        'order': 'ASCENDING'|'DESCENDING'
    }
)

Parameters:

• additionalAttributes (list) –

  Specifies additional attributes for the search.

  • (string) –

• domainIdentifier (string) –

  [REQUIRED]

  The identifier of the domain in which to search listings.

• filters (dict) –

  Specifies the filters for the search of listings.

  Note

  This is a Tagged Union structure. Only one of the following top level keys can be set: and, filter, or.

  • and (list) –

    The ‘and’ search filter clause in Amazon DataZone.

    • (dict) –

      A search filter clause in Amazon DataZone.

      Note

      This is a Tagged Union structure. Only one of the following top level keys can be set: and, filter, or.

  • filter (dict) –

    A search filter in Amazon DataZone.

    • attribute (string) – [REQUIRED]

      A search filter attribute in Amazon DataZone.

    • value (string) – [REQUIRED]

      A search filter value in Amazon DataZone.

  • or (list) –

    The ‘or’ search filter clause in Amazon DataZone.

    • (dict) –

      A search filter clause in Amazon DataZone.

      Note

      This is a Tagged Union structure. Only one of the following top level keys can be set: and, filter, or.

• maxResults (integer) – The maximum number of results to return in a single call to SearchListings. When the number of results to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to SearchListings to list the next set of results.

• nextToken (string) – When the number of results is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of results, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to SearchListings to list the next set of results.

• searchIn (list) –

  • (dict) –

    The details of the search.

    • attribute (string) – [REQUIRED]

      The search attribute.

• searchText (string) – Specifies the text for which to search.

• sort (dict) –

  Specifies the way for sorting the search results.

  • attribute (string) – [REQUIRED]

    The attribute detail of the way to sort search results.

  • order (string) –

    The order detail of the wya to sort search results.

Return type:

dict

Returns:

Response Syntax

{
    'items': [
        {
            'assetListing': {
                'additionalAttributes': {
                    'forms': 'string'
                },
                'createdAt': datetime(2015, 1, 1),
                'description': 'string',
                'entityId': 'string',
                'entityRevision': 'string',
                'entityType': 'string',
                'glossaryTerms': [
                    {
                        'name': 'string',
                        'shortDescription': 'string'
                    },
                ],
                'listingCreatedBy': 'string',
                'listingId': 'string',
                'listingRevision': 'string',
                'listingUpdatedBy': 'string',
                'name': 'string',
                'owningProjectId': 'string'
            }
        },
    ],
    'nextToken': 'string',
    'totalMatchCount': 123
}

Response Structure

• (dict) –

  • items (list) –

    The results of the SearchListings action.

    • (dict) –

      The details of the results of the SearchListings action.

      Note

      This is a Tagged Union structure. Only one of the following top level keys will be set: assetListing. 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) –

        The asset listing included in the results of the SearchListings action.

        • additionalAttributes (dict) –

          The additional attributes of an asset published in an Amazon DataZone catalog.

          • forms (string) –

            The metadata forms that form additional attributes of the metadata asset.

        • createdAt (datetime) –

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

        • description (string) –

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

        • entityId (string) –

          The identifier of the inventory asset.

        • entityRevision (string) –

          The revision of the inventory asset.

        • entityType (string) –

          The type of the inventory asset.

        • glossaryTerms (list) –

          Glossary terms attached to the inventory 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.

        • listingCreatedBy (string) –

          The Amazon DataZone user who created the listing.

        • listingId (string) –

          The identifier of the listing (asset published in Amazon DataZone catalog).

        • listingRevision (string) –

          The revision of the listing (asset published in Amazon DataZone catalog).

        • listingUpdatedBy (string) –

          The Amazon DataZone user who updated the listing.

        • name (string) –

          The name of the inventory asset.

        • owningProjectId (string) –

          The identifier of the project that owns the inventory asset.

  • nextToken (string) –

    When the number of results is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of results, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to SearchListings to list the next set of results.

  • totalMatchCount (integer) –

    Total number of search results.

Exceptions

• DataZone.Client.exceptions.InternalServerException

• DataZone.Client.exceptions.AccessDeniedException

• DataZone.Client.exceptions.ThrottlingException

• DataZone.Client.exceptions.ValidationException

• DataZone.Client.exceptions.UnauthorizedException