DataZone / Client / query_graph

query_graph¶

DataZone.Client.query_graph(**kwargs)¶

Queries entities in the graph store.

Request Syntax

response = client.query_graph(
    domainIdentifier='string',
    match=[
        {
            'relationPattern': {
                'relationType': 'LINEAGE',
                'relationDirection': 'IN'|'OUT',
                'maxPathLength': 123
            },
            'entityPattern': {
                'entityType': 'LINEAGE_NODE',
                'identifier': 'string',
                'filters': {
                    'filter': {
                        'attribute': 'string',
                        'value': 'string',
                        'intValue': 123,
                        'operator': 'EQ'|'LE'|'LT'|'GE'|'GT'|'TEXT_SEARCH'
                    },
                    'and': [
                        {'... recursive ...'},
                    ],
                    'or': [
                        {'... recursive ...'},
                    ]
                }
            }
        },
    ],
    maxResults=123,
    nextToken='string',
    additionalAttributes={
        'formNames': [
            'string',
        ]
    }
)

Parameters:

domainIdentifier (string) –
[REQUIRED]

The identifier of the Amazon DataZone domain.
match (list) –
[REQUIRED]

List of query match clauses.
- (dict) –
  
  A clause to match a query pattern
  
  Note
  This is a Tagged Union structure. Only one of the following top level keys can be set: relationPattern, entityPattern.
  - relationPattern (dict) –
    
    The pattern describing the query’s relational traversal.
    - relationType (string) – [REQUIRED]
      
      The type of relation to query.
    - relationDirection (string) – [REQUIRED]
      
      The direction to query.
    - maxPathLength (integer) –
      
      The number of hops to query.
  - entityPattern (dict) –
    
    The pattern describing the entities for the query to traverse.
    - entityType (string) – [REQUIRED]
      
      The type of entity to be matched during the graph query.
    - identifier (string) – [REQUIRED]
      
      The identifier of the root entity to start traversal from during the graph query.
    - filters (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: filter, and, or.
      - filter (dict) –
        
        A search filter in Amazon DataZone.
        
        attribute (string) – [REQUIRED]
        
        A search filter attribute in Amazon DataZone.
        
        value (string) –
        
        A search filter string value in Amazon DataZone.
        
        intValue (integer) –
        
        A search filter integer value in Amazon DataZone.
        
        operator (string) –
        
        Specifies the search filter operator.
      - 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: filter, and, or.
      - 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: filter, and, or.
maxResults (integer) – The maximum number of entities to return in a single call to QueryGraph. 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 QueryGraph to list the next set of entities.
nextToken (string) – 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 QueryGraph to list the next set of entities.
additionalAttributes (dict) –
Additional details on the queried entity that can be requested in the response.
- formNames (list) –
  
  Names of forms on the query entity that can be requested in the response.
  - (string) –

Return type:

dict

Returns:

Response Syntax

{
    'items': [
        {
            'lineageNode': {
                'domainId': 'string',
                'name': 'string',
                'description': 'string',
                'createdAt': datetime(2015, 1, 1),
                'createdBy': 'string',
                'updatedAt': datetime(2015, 1, 1),
                'updatedBy': 'string',
                'id': 'string',
                'typeName': 'string',
                'typeRevision': 'string',
                'sourceIdentifier': 'string',
                'eventTimestamp': datetime(2015, 1, 1),
                'formsOutput': [
                    {
                        'formName': 'string',
                        'typeName': 'string',
                        'typeRevision': 'string',
                        'content': 'string'
                    },
                ],
                'upstreamLineageNodeIds': [
                    'string',
                ],
                'downstreamLineageNodeIds': [
                    'string',
                ]
            }
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) –
- items (list) –
  
  The results of the QueryGraph action.
  - (dict) –
    
    Resulting entity from the query.
    Note
    This is a Tagged Union structure. Only one of the following top level keys will be set: lineageNode. 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'}
    - lineageNode (dict) –
      
      Resulting data lineage node from the query.
      - domainId (string) –
        
        The ID of the domain of the data lineage node.
      - name (string) –
        
        The name of the data lineage node.
      - description (string) –
        
        The description of the data lineage node.
      - createdAt (datetime) –
        
        The timestamp at which the data lineage node was created.
      - createdBy (string) –
        
        The user who created the data lineage node.
      - updatedAt (datetime) –
        
        The timestamp at which the data lineage node was updated.
      - updatedBy (string) –
        
        The user who updated the data lineage node.
      - id (string) –
        
        The ID of the data lineage node.
      - typeName (string) –
        
        The name of the type of the data lineage node.
      - typeRevision (string) –
        
        The type of the revision of the data lineage node.
      - sourceIdentifier (string) –
        
        The alternate ID of the data lineage node.
      - eventTimestamp (datetime) –
        
        The event timestamp of the data lineage node.
      - formsOutput (list) –
        
        The forms included in the additional attributes of a data lineage node.
        
        (dict) –
        
        The details of a metadata form.
        
        formName (string) –
        
        The name of the metadata form.
        
        typeName (string) –
        
        The name of the metadata form type.
        
        typeRevision (string) –
        
        The revision of the metadata form type.
        
        content (string) –
        
        The content of the metadata form.
      - upstreamLineageNodeIds (list) –
        
        The IDs of the upstream data lineage nodes.
        
        (string) –
      - downstreamLineageNodeIds (list) –
        
        The IDs of the downstream data lineage nodes.
        
        (string) –
- nextToken (string) –
  
  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 QueryGraph to list the next set of entities.

Exceptions

DataZone.Client.exceptions.InternalServerException
DataZone.Client.exceptions.AccessDeniedException
DataZone.Client.exceptions.ThrottlingException
DataZone.Client.exceptions.ValidationException
DataZone.Client.exceptions.UnauthorizedException