aws_sdk_controlcatalog/client/
list_objectives.rs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`ListObjectives`](crate::operation::list_objectives::builders::ListObjectivesFluentBuilder) operation.
    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_objectives::builders::ListObjectivesFluentBuilder::into_paginator).
    ///
    /// - The fluent builder is configurable:
    ///   - [`max_results(i32)`](crate::operation::list_objectives::builders::ListObjectivesFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_objectives::builders::ListObjectivesFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of results on a page or for an API request call.</p><br>
    ///   - [`next_token(impl Into<String>)`](crate::operation::list_objectives::builders::ListObjectivesFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_objectives::builders::ListObjectivesFluentBuilder::set_next_token):<br>required: **false**<br><p>The pagination token that's used to fetch the next set of results.</p><br>
    ///   - [`objective_filter(ObjectiveFilter)`](crate::operation::list_objectives::builders::ListObjectivesFluentBuilder::objective_filter) / [`set_objective_filter(Option<ObjectiveFilter>)`](crate::operation::list_objectives::builders::ListObjectivesFluentBuilder::set_objective_filter):<br>required: **false**<br><p>An optional filter that narrows the results to a specific domain.</p> <p>This filter allows you to specify one domain ARN at a time. Passing multiple ARNs in the <code>ObjectiveFilter</code> isn’t currently supported.</p><br>
    /// - On success, responds with [`ListObjectivesOutput`](crate::operation::list_objectives::ListObjectivesOutput) with field(s):
    ///   - [`objectives(Vec::<ObjectiveSummary>)`](crate::operation::list_objectives::ListObjectivesOutput::objectives): <p>The list of objectives that the <code>ListObjectives</code> API returns.</p>
    ///   - [`next_token(Option<String>)`](crate::operation::list_objectives::ListObjectivesOutput::next_token): <p>The pagination token that's used to fetch the next set of results.</p>
    /// - On failure, responds with [`SdkError<ListObjectivesError>`](crate::operation::list_objectives::ListObjectivesError)
    pub fn list_objectives(&self) -> crate::operation::list_objectives::builders::ListObjectivesFluentBuilder {
        crate::operation::list_objectives::builders::ListObjectivesFluentBuilder::new(self.handle.clone())
    }
}