Search Types

datazone_search_types

R Documentation

Searches for types in Amazon DataZone

Description

Searches for types in Amazon DataZone.

Prerequisites:

• The –domain-identifier must refer to an existing Amazon DataZone domain.

• –search-scope must be one of the valid values including: ASSET_TYPE, GLOSSARY_TERM_TYPE, DATA_PRODUCT_TYPE.

• The –managed flag must be present without a value.

• The user must have permissions for form or asset types in the domain.

• If using –filters, ensure that the JSON is valid.

• Filters contain correct structure (attribute, value, operator).

Usage

datazone_search_types(domainIdentifier, maxResults, nextToken,
  searchScope, searchText, searchIn, filters, sort, managed)

Arguments

domainIdentifier	[required] The identifier of the Amazon DataZone domain in which to invoke the search_types action.
maxResults	The maximum number of results to return in a single call to search_types. 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_types 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_types to list the next set of results.
searchScope	[required] Specifies the scope of the search for types.
searchText	Specifies the text for which to search.
searchIn	The details of the search.
filters	The filters for the search_types action.
sort	The specifies the way to sort the search_types results.
managed	[required] Specifies whether the search is managed.

Value

A list with the following syntax:

list(
  items = list(
    list(
      assetTypeItem = list(
        domainId = "string",
        name = "string",
        revision = "string",
        description = "string",
        formsOutput = list(
          list(
            typeName = "string",
            typeRevision = "string",
            required = TRUE|FALSE
          )
        ),
        owningProjectId = "string",
        originDomainId = "string",
        originProjectId = "string",
        createdAt = as.POSIXct(
          "2015-01-01"
        ),
        createdBy = "string",
        updatedAt = as.POSIXct(
          "2015-01-01"
        ),
        updatedBy = "string"
      ),
      formTypeItem = list(
        domainId = "string",
        name = "string",
        revision = "string",
        model = list(
          smithy = "string"
        ),
        status = "ENABLED"|"DISABLED",
        owningProjectId = "string",
        originDomainId = "string",
        originProjectId = "string",
        createdAt = as.POSIXct(
          "2015-01-01"
        ),
        createdBy = "string",
        description = "string",
        imports = list(
          list(
            name = "string",
            revision = "string"
          )
        )
      ),
      lineageNodeTypeItem = list(
        domainId = "string",
        name = "string",
        description = "string",
        createdAt = as.POSIXct(
          "2015-01-01"
        ),
        createdBy = "string",
        updatedAt = as.POSIXct(
          "2015-01-01"
        ),
        updatedBy = "string",
        revision = "string",
        formsOutput = list(
          list(
            typeName = "string",
            typeRevision = "string",
            required = TRUE|FALSE
          )
        )
      )
    )
  ),
  nextToken = "string",
  totalMatchCount = 123
)

Request syntax

svc$search_types(
  domainIdentifier = "string",
  maxResults = 123,
  nextToken = "string",
  searchScope = "ASSET_TYPE"|"FORM_TYPE"|"LINEAGE_NODE_TYPE",
  searchText = "string",
  searchIn = list(
    list(
      attribute = "string"
    )
  ),
  filters = list(
    filter = list(
      attribute = "string",
      value = "string",
      intValue = 123,
      operator = "EQ"|"LE"|"LT"|"GE"|"GT"|"TEXT_SEARCH"
    ),
    and = list(
      list()
    ),
    or = list(
      list()
    )
  ),
  sort = list(
    attribute = "string",
    order = "ASCENDING"|"DESCENDING"
  ),
  managed = TRUE|FALSE
)