Struct aws_sdk_applicationdiscovery::client::fluent_builders::DescribeAgents

pub struct DescribeAgents { /* private fields */ }

Fluent builder constructing a request to DescribeAgents.

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

Implementations

impl DescribeAgents

pub async fn customize(
    self
) -> Result<CustomizableOperation<DescribeAgents, AwsResponseRetryClassifier>, SdkError<DescribeAgentsError>>

Consume this builder, creating a customizable operation that can be modified before being sent. The operation’s inner http::Request can be modified as well.

pub async fn send(
    self
) -> Result<DescribeAgentsOutput, SdkError<DescribeAgentsError>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn agent_ids(self, input: impl Into<String>) -> Self

Appends an item to agentIds.

To override the contents of this collection use set_agent_ids.

The agent or the Connector IDs for which you want information. If you specify no IDs, the system returns information about all agents/Connectors associated with your Amazon Web Services user account.

pub fn set_agent_ids(self, input: Option<Vec<String>>) -> Self

The agent or the Connector IDs for which you want information. If you specify no IDs, the system returns information about all agents/Connectors associated with your Amazon Web Services user account.

pub fn filters(self, input: Filter) -> Self

Appends an item to filters.

To override the contents of this collection use set_filters.

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

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

pub fn set_filters(self, input: Option<Vec<Filter>>) -> Self

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

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

pub fn max_results(self, input: i32) -> Self

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

pub fn set_max_results(self, input: Option<i32>) -> Self

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

pub fn next_token(self, input: impl Into<String>) -> Self

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.

pub fn set_next_token(self, input: Option<String>) -> Self

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.

Trait Implementations

impl Clone for DescribeAgents

fn clone(&self) -> DescribeAgents

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DescribeAgents

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

Formats the value using the given formatter.