Struct DescribeAgentsInput 

#[non_exhaustive]
pub struct DescribeAgentsInput {
    pub agent_ids: Option<Vec<String>>,
    pub filters: Option<Vec<Filter>>,
    pub max_results: Option<i32>,
    pub next_token: Option<String>,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

agent_ids: Option<Vec<String>>

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: Option<Vec<Filter>>

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

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

max_results: Option<i32>

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

next_token: Option<String>

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.

Implementations

impl DescribeAgentsInput

pub fn agent_ids(&self) -> &[String]

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.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .agent_ids.is_none().

pub fn filters(&self) -> &[Filter]

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

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

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .filters.is_none().

pub fn max_results(&self) -> Option<i32>

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

pub fn next_token(&self) -> Option<&str>

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.

impl DescribeAgentsInput

pub fn builder() -> DescribeAgentsInputBuilder

Creates a new builder-style object to manufacture DescribeAgentsInput.

Trait Implementations

impl Clone for DescribeAgentsInput

fn clone(&self) -> DescribeAgentsInput

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for DescribeAgentsInput

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for DescribeAgentsInput

fn eq(&self, other: &DescribeAgentsInput) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for DescribeAgentsInput