Skip to content

DescribeAgentsRequest

Source code in docs_src/capo_application_discovery_service/types/describe_agents_request.py 
14
15
16
17
18
19
20
21
22
23
24
25
26
class DescribeAgentsRequest(TypedDict, closed=True):
    agent_ids: NotRequired[
        "capo_application_discovery_service.types.agent_ids.AgentIds"
    ]
    """<p>The agent or the collector IDs for which you want information. If you specify no IDs, the system returns information about all agents/collectors associated with your user.</p>"""
    filters: NotRequired["capo_application_discovery_service.types.filters.Filters"]
    """<p>You can filter the request using various logical operators and a <i>key</i>-<i>value</i> format. For example: </p> <p> <code>{"key": "collectionStatus", "value": "STARTED"}</code> </p>"""
    max_results: "capo_application_discovery_service.types.integer.Integer"
    """<p>The total number of agents/collectors to return in a single page of output. The maximum value is 100.</p>"""
    next_token: NotRequired[
        "capo_application_discovery_service.types.next_token.NextToken"
    ]
    """<p>Token to retrieve the next set of results. For example, if you previously specified 100 IDs for <code>DescribeAgentsRequest$agentIds</code> but set <code>DescribeAgentsRequest$maxResults</code> to 10, you received a set of 10 results along with a token. Use that token in this query to get the next set of 10.</p>"""

agent_ids instance-attribute 

agent_ids: NotRequired[AgentIds]

The agent or the collector IDs for which you want information. If you specify no IDs, the system returns information about all agents/collectors associated with your user.

filters instance-attribute 

filters: NotRequired[Filters]

You can filter the request using various logical operators and a key-value format. For example:

{"key": "collectionStatus", "value": "STARTED"}

max_results instance-attribute 

max_results: Integer

The total number of agents/collectors to return in a single page of output. The maximum value is 100.

next_token instance-attribute 

next_token: NotRequired[NextToken]

Token to retrieve the next set of results. For example, if you previously specified 100 IDs for DescribeAgentsRequest$agentIds but set DescribeAgentsRequest$maxResults to 10, you received a set of 10 results along with a token. Use that token in this query to get the next set of 10.