Skip to content

query_graph async

query_graph(
    domain_identifier: DomainId,
    match: MatchClauses,
    *,
    config_overrides: Optional[AsyncDataZoneClientConfig] = None,
    max_results: Optional[MaxResults] = None,
    next_token: Optional[PaginationToken] = None,
    additional_attributes: Optional[AdditionalAttributes] = None,
) -> QueryGraphOutput

Queries entities in the graph store.

Parameters:

  • domain_identifier (DomainId) –

    The identifier of the Amazon DataZone domain.

  • match (MatchClauses) –

    List of query match clauses.

  • max_results (Optional[MaxResults], default: None ) –

    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.

  • next_token (Optional[PaginationToken], default: None ) –

    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.

  • additional_attributes (Optional[AdditionalAttributes], default: None ) –

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

Raises:

Source code in docs_src/capo_datazone/_services/async_data_zone.py
async def query_graph(
    self,
    domain_identifier: "capo_datazone.types.domain_id.DomainId",
    match: "capo_datazone.types.match_clauses.MatchClauses",
    *,
    config_overrides: Optional[AsyncDataZoneClientConfig] = None,
    max_results: Optional["capo_datazone.types.max_results.MaxResults"] = None,
    next_token: Optional[
        "capo_datazone.types.pagination_token.PaginationToken"
    ] = None,
    additional_attributes: Optional[
        "capo_datazone.types.additional_attributes.AdditionalAttributes"
    ] = None,
) -> "capo_datazone.types.query_graph_output.QueryGraphOutput":
    """<p>Queries entities in the graph store.</p>

    Args:
        domain_identifier: <p>The identifier of the Amazon DataZone domain.</p>
        match: <p>List of query match clauses.</p>
        max_results: <p>The maximum number of entities to return in a single call to <code>QueryGraph</code>. When the number of entities to be listed is greater than the value of <code>MaxResults</code>, the response contains a <code>NextToken</code> value that you can use in a subsequent call to <code>QueryGraph</code> to list the next set of entities.</p>
        next_token: <p>When the number of entities is greater than the default value for the <code>MaxResults</code> parameter, or if you explicitly specify a value for <code>MaxResults</code> that is less than the number of entities, the response includes a pagination token named <code>NextToken</code>. You can specify this <code>NextToken</code> value in a subsequent call to <code>QueryGraph</code> to list the next set of entities.</p>
        additional_attributes: <p>Additional details on the queried entity that can be requested in the response.</p>

    Raises:
        capo_datazone.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient access to perform this action.</p>
        capo_datazone.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling.</p>
        capo_datazone.errors.unauthorized_exception.UnauthorizedException: <p>You do not have permission to perform this action.</p>
        capo_datazone.errors.internal_server_exception.InternalServerException: <p>The request has failed because of an unknown error, exception or failure.</p>
        capo_datazone.errors.validation_exception.ValidationException: <p>The input fails to satisfy the constraints specified by the Amazon Web Services service.</p>
        capo_datazone.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_datazone.types.query_graph_input.QueryGraphInput]",
    ) -> AsyncOperationResponse[
        "capo_datazone.types.query_graph_output.QueryGraphOutput"
    ]:
        import capo_datazone._operations.data_zone.query_graph

        (
            output,
            http_response,
        ) = await capo_datazone._operations.data_zone.query_graph.async_query_graph(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    def _redact_output(
        output: "capo_datazone.types.query_graph_output.QueryGraphOutput",
    ) -> dict[str, Any]:
        import capo_datazone.types.query_graph_output

        return capo_datazone.types.query_graph_output.redact_sensitive(output)

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("QueryGraph", redact_output=_redact_output),
    )
    input_: capo_datazone.types.query_graph_input.QueryGraphInput = {
        "domain_identifier": domain_identifier,
        "match": match,
    }
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token
    if additional_attributes is not None:
        input_["additional_attributes"] = additional_attributes

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output