1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`DescribeAgents`](crate::operation::describe_agents::builders::DescribeAgentsFluentBuilder) operation.
    /// This operation supports pagination; See [`into_paginator()`](crate::operation::describe_agents::builders::DescribeAgentsFluentBuilder::into_paginator).
    ///
    /// - The fluent builder is configurable:
    ///   - [`agent_ids(impl Into<String>)`](crate::operation::describe_agents::builders::DescribeAgentsFluentBuilder::agent_ids) / [`set_agent_ids(Option<Vec::<String>>)`](crate::operation::describe_agents::builders::DescribeAgentsFluentBuilder::set_agent_ids):<br>required: **false**<br><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><br>
    ///   - [`filters(Filter)`](crate::operation::describe_agents::builders::DescribeAgentsFluentBuilder::filters) / [`set_filters(Option<Vec::<Filter>>)`](crate::operation::describe_agents::builders::DescribeAgentsFluentBuilder::set_filters):<br>required: **false**<br><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><br>
    ///   - [`max_results(i32)`](crate::operation::describe_agents::builders::DescribeAgentsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::describe_agents::builders::DescribeAgentsFluentBuilder::set_max_results):<br>required: **false**<br><p>The total number of agents/collectors to return in a single page of output. The maximum value is 100.</p><br>
    ///   - [`next_token(impl Into<String>)`](crate::operation::describe_agents::builders::DescribeAgentsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::describe_agents::builders::DescribeAgentsFluentBuilder::set_next_token):<br>required: **false**<br><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><br>
    /// - On success, responds with [`DescribeAgentsOutput`](crate::operation::describe_agents::DescribeAgentsOutput) with field(s):
    ///   - [`agents_info(Option<Vec::<AgentInfo>>)`](crate::operation::describe_agents::DescribeAgentsOutput::agents_info): <p>Lists agents or the collector by ID or lists all agents/collectors associated with your user, if you did not specify an agent/collector ID. The output includes agent/collector IDs, IP addresses, media access control (MAC) addresses, agent/collector health, host name where the agent/collector resides, and the version number of each agent/collector.</p>
    ///   - [`next_token(Option<String>)`](crate::operation::describe_agents::DescribeAgentsOutput::next_token): <p>Token to retrieve the next set of results. For example, if you 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 this token. Use this token in the next query to retrieve the next set of 10.</p>
    /// - On failure, responds with [`SdkError<DescribeAgentsError>`](crate::operation::describe_agents::DescribeAgentsError)
    pub fn describe_agents(&self) -> crate::operation::describe_agents::builders::DescribeAgentsFluentBuilder {
        crate::operation::describe_agents::builders::DescribeAgentsFluentBuilder::new(self.handle.clone())
    }
}