aws_sdk_databasemigration/client/
describe_fleet_advisor_collectors.rs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`DescribeFleetAdvisorCollectors`](crate::operation::describe_fleet_advisor_collectors::builders::DescribeFleetAdvisorCollectorsFluentBuilder) operation.
    /// This operation supports pagination; See [`into_paginator()`](crate::operation::describe_fleet_advisor_collectors::builders::DescribeFleetAdvisorCollectorsFluentBuilder::into_paginator).
    ///
    /// - The fluent builder is configurable:
    ///   - [`filters(Filter)`](crate::operation::describe_fleet_advisor_collectors::builders::DescribeFleetAdvisorCollectorsFluentBuilder::filters) / [`set_filters(Option<Vec::<Filter>>)`](crate::operation::describe_fleet_advisor_collectors::builders::DescribeFleetAdvisorCollectorsFluentBuilder::set_filters):<br>required: **false**<br><p>If you specify any of the following filters, the output includes information for only those collectors that meet the filter criteria:</p> <ul>  <li>   <p><code>collector-referenced-id</code> – The ID of the collector agent, for example <code>d4610ac5-e323-4ad9-bc50-eaf7249dfe9d</code>.</p></li>  <li>   <p><code>collector-name</code> – The name of the collector agent.</p></li> </ul> <p>An example is: <code>describe-fleet-advisor-collectors --filter Name="collector-referenced-id",Values="d4610ac5-e323-4ad9-bc50-eaf7249dfe9d"</code></p><br>
    ///   - [`max_records(i32)`](crate::operation::describe_fleet_advisor_collectors::builders::DescribeFleetAdvisorCollectorsFluentBuilder::max_records) / [`set_max_records(Option<i32>)`](crate::operation::describe_fleet_advisor_collectors::builders::DescribeFleetAdvisorCollectorsFluentBuilder::set_max_records):<br>required: **false**<br><p>Sets the maximum number of records returned in the response.</p><br>
    ///   - [`next_token(impl Into<String>)`](crate::operation::describe_fleet_advisor_collectors::builders::DescribeFleetAdvisorCollectorsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::describe_fleet_advisor_collectors::builders::DescribeFleetAdvisorCollectorsFluentBuilder::set_next_token):<br>required: **false**<br><p>If <code>NextToken</code> is returned by a previous response, there are more results available. The value of <code>NextToken</code> is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.</p><br>
    /// - On success, responds with [`DescribeFleetAdvisorCollectorsOutput`](crate::operation::describe_fleet_advisor_collectors::DescribeFleetAdvisorCollectorsOutput) with field(s):
    ///   - [`collectors(Option<Vec::<CollectorResponse>>)`](crate::operation::describe_fleet_advisor_collectors::DescribeFleetAdvisorCollectorsOutput::collectors): <p>Provides descriptions of the Fleet Advisor collectors, including the collectors' name and ID, and the latest inventory data.</p>
    ///   - [`next_token(Option<String>)`](crate::operation::describe_fleet_advisor_collectors::DescribeFleetAdvisorCollectorsOutput::next_token): <p>If <code>NextToken</code> is returned, there are more results available. The value of <code>NextToken</code> is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.</p>
    /// - On failure, responds with [`SdkError<DescribeFleetAdvisorCollectorsError>`](crate::operation::describe_fleet_advisor_collectors::DescribeFleetAdvisorCollectorsError)
    pub fn describe_fleet_advisor_collectors(
        &self,
    ) -> crate::operation::describe_fleet_advisor_collectors::builders::DescribeFleetAdvisorCollectorsFluentBuilder {
        crate::operation::describe_fleet_advisor_collectors::builders::DescribeFleetAdvisorCollectorsFluentBuilder::new(self.handle.clone())
    }
}