Queries entities in the graph store¶

Description¶

Queries entities in the graph store.

Usage¶

datazone_query_graph(domainIdentifier, match, maxResults, nextToken,
  additionalAttributes)

Arguments¶

domainIdentifier

[required] The identifier of the Amazon DataZone domain.
match

[required] List of query match clauses.
maxResults

The maximum number of entities to return in a single call to query_graph. When the number of entities 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 query_graph to list the next set of entities.
nextToken

When the number of entities 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 entities, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to query_graph to list the next set of entities.
additionalAttributes

Additional details on the queried entity that can be requested in the response.

Value¶

A list with the following syntax:

list(
  items = list(
    list(
      lineageNode = list(
        domainId = "string",
        name = "string",
        description = "string",
        createdAt = as.POSIXct(
          "2015-01-01"
        ),
        createdBy = "string",
        updatedAt = as.POSIXct(
          "2015-01-01"
        ),
        updatedBy = "string",
        id = "string",
        typeName = "string",
        typeRevision = "string",
        sourceIdentifier = "string",
        eventTimestamp = as.POSIXct(
          "2015-01-01"
        ),
        formsOutput = list(
          list(
            formName = "string",
            typeName = "string",
            typeRevision = "string",
            content = "string"
          )
        ),
        upstreamLineageNodeIds = list(
          "string"
        ),
        downstreamLineageNodeIds = list(
          "string"
        )
      )
    )
  ),
  nextToken = "string"
)

Request syntax¶

svc$query_graph(
  domainIdentifier = "string",
  match = list(
    list(
      relationPattern = list(
        relationType = "LINEAGE",
        relationDirection = "IN"|"OUT",
        maxPathLength = 123
      ),
      entityPattern = list(
        entityType = "LINEAGE_NODE",
        identifier = "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()
          )
        )
      )
    )
  ),
  maxResults = 123,
  nextToken = "string",
  additionalAttributes = list(
    formNames = list(
      "string"
    )
  )
)