Module Values.DescribeAgentsRequestSource

Lists agents or collectors as specified by ID or other filters. All agents/collectors associated with your user can be listed if you call DescribeAgents as is without passing any parameters.

Sourcetype nonrec t = {
  1. agentIds : AgentIds.t option;
    (*

    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.

    *)
  2. filters : Filters.t option;
    (*

    You can filter the request using various logical operators and a key-value format. For example: {"key": "collectionStatus", "value": "STARTED"}

    *)
  3. maxResults : Integer.t option;
    (*

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

    *)
  4. nextToken : NextToken.t option;
    (*

    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.

    *)
}
Sourceval make : ?agentIds:??? -> ?filters:??? -> ?maxResults:??? -> ?nextToken:??? -> unit -> t
Sourceval to_value : t -> [> `Structure of (string * [> `Integer of Integer.t | `List of [> `String of AgentId.t | `Structure of (string * [> `List of [> `String of FilterValue.t ] list | `String of String_.t ]) list ] list | `String of NextToken.t ]) list ]
Sourceval to_query : t -> Awso.Client.Query.t
Sourceval of_xml : Awso.Xml.t -> t
Sourceval of_string : string -> t
Sourceval of_json : Yojson.Safe.t -> t
Sourceval to_json : t -> Yojson.Safe.t