Search Listings

datazone_search_listings

R Documentation

Searches listings (records of an asset at a given time) in Amazon DataZone

Description

Searches listings (records of an asset at a given time) in Amazon DataZone.

Usage

datazone_search_listings(additionalAttributes, domainIdentifier,
  filters, maxResults, nextToken, searchIn, searchText, sort)

Arguments

additionalAttributes

Specifies additional attributes for the search.

domainIdentifier

[required] The identifier of the domain in which to search listings.

filters

Specifies the filters for the search of listings.

maxResults

The maximum number of results to return in a single call to search_listings. 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 search_listings to list the next set of results.

nextToken

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 search_listings to list the next set of results.

searchIn

The details of the search.

searchText

Specifies the text for which to search.

sort

Specifies the way for sorting the search results.

Value

A list with the following syntax:

list(
  items = list(
    list(
      assetListing = list(
        additionalAttributes = list(
          forms = "string",
          latestTimeSeriesDataPointForms = list(
            list(
              contentSummary = "string",
              formName = "string",
              id = "string",
              timestamp = as.POSIXct(
                "2015-01-01"
              ),
              typeIdentifier = "string",
              typeRevision = "string"
            )
          )
        ),
        createdAt = as.POSIXct(
          "2015-01-01"
        ),
        description = "string",
        entityId = "string",
        entityRevision = "string",
        entityType = "string",
        glossaryTerms = list(
          list(
            name = "string",
            shortDescription = "string"
          )
        ),
        listingCreatedBy = "string",
        listingId = "string",
        listingRevision = "string",
        listingUpdatedBy = "string",
        name = "string",
        owningProjectId = "string"
      ),
      dataProductListing = list(
        additionalAttributes = list(
          forms = "string"
        ),
        createdAt = as.POSIXct(
          "2015-01-01"
        ),
        description = "string",
        entityId = "string",
        entityRevision = "string",
        glossaryTerms = list(
          list(
            name = "string",
            shortDescription = "string"
          )
        ),
        items = list(
          list(
            glossaryTerms = list(
              list(
                name = "string",
                shortDescription = "string"
              )
            ),
            listingId = "string",
            listingRevision = "string"
          )
        ),
        listingCreatedBy = "string",
        listingId = "string",
        listingRevision = "string",
        listingUpdatedBy = "string",
        name = "string",
        owningProjectId = "string"
      )
    )
  ),
  nextToken = "string",
  totalMatchCount = 123
)

Request syntax

svc$search_listings(
  additionalAttributes = list(
    "FORMS"|"TIME_SERIES_DATA_POINT_FORMS"
  ),
  domainIdentifier = "string",
  filters = list(
    and = list(
      list()
    ),
    filter = list(
      attribute = "string",
      value = "string"
    ),
    or = list(
      list()
    )
  ),
  maxResults = 123,
  nextToken = "string",
  searchIn = list(
    list(
      attribute = "string"
    )
  ),
  searchText = "string",
  sort = list(
    attribute = "string",
    order = "ASCENDING"|"DESCENDING"
  )
)