Skip to content

GetContextGraphInput

Source code in docs_src/capo_cloudwatchomni/types/get_context_graph_input.py
class GetContextGraphInput(TypedDict, closed=True):
    node_filters: NotRequired["capo_cloudwatchomni.types.node_filters.NodeFilters"]
    """Criteria restricting which nodes are returned."""
    edge_filters: NotRequired["capo_cloudwatchomni.types.edge_filters.EdgeFilters"]
    """Criteria restricting which edges are returned."""
    start_time: "datetime.datetime"
    """Start of the time range (UTC), inclusive."""
    end_time: "datetime.datetime"
    """End of the time range (UTC), inclusive."""
    depth: NotRequired["int"]
    """How many hops to traverse out from the nodes matched by nodeFilters. 0 returns only the matched nodes themselves."""
    max_results: NotRequired["int"]
    """The maximum number of nodes to return in a single page."""
    max_edges_per_node: NotRequired["int"]
    """The maximum number of edges to return per node, bounding the fan-out of a densely connected node."""
    include_metadata: NotRequired["bool"]
    """Whether to return the metadata block, semantics included, on each node and edge. Off by default because it costs an extra lookup per returned node."""
    next_token: NotRequired[
        "capo_cloudwatchomni.types.pagination_token.PaginationToken"
    ]
    """Pagination token from a previous response, to retrieve the next page."""

depth instance-attribute

depth: NotRequired[int]

How many hops to traverse out from the nodes matched by nodeFilters. 0 returns only the matched nodes themselves.

edge_filters instance-attribute

edge_filters: NotRequired[EdgeFilters]

Criteria restricting which edges are returned.

end_time instance-attribute

end_time: datetime

End of the time range (UTC), inclusive.

include_metadata instance-attribute

include_metadata: NotRequired[bool]

Whether to return the metadata block, semantics included, on each node and edge. Off by default because it costs an extra lookup per returned node.

max_edges_per_node instance-attribute

max_edges_per_node: NotRequired[int]

The maximum number of edges to return per node, bounding the fan-out of a densely connected node.

max_results instance-attribute

max_results: NotRequired[int]

The maximum number of nodes to return in a single page.

next_token instance-attribute

next_token: NotRequired[PaginationToken]

Pagination token from a previous response, to retrieve the next page.

node_filters instance-attribute

node_filters: NotRequired[NodeFilters]

Criteria restricting which nodes are returned.

start_time instance-attribute

start_time: datetime

Start of the time range (UTC), inclusive.