Skip to main content

aws_sdk_devopsagent/client/
list_goals.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3    /// Constructs a fluent builder for the [`ListGoals`](crate::operation::list_goals::builders::ListGoalsFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_goals::builders::ListGoalsFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`agent_space_id(impl Into<String>)`](crate::operation::list_goals::builders::ListGoalsFluentBuilder::agent_space_id) / [`set_agent_space_id(Option<String>)`](crate::operation::list_goals::builders::ListGoalsFluentBuilder::set_agent_space_id):<br>required: **true**<br>The unique identifier for the agent space<br>
8    ///   - [`status(GoalStatus)`](crate::operation::list_goals::builders::ListGoalsFluentBuilder::status) / [`set_status(Option<GoalStatus>)`](crate::operation::list_goals::builders::ListGoalsFluentBuilder::set_status):<br>required: **false**<br>Filter goals by goal status<br>
9    ///   - [`goal_type(GoalType)`](crate::operation::list_goals::builders::ListGoalsFluentBuilder::goal_type) / [`set_goal_type(Option<GoalType>)`](crate::operation::list_goals::builders::ListGoalsFluentBuilder::set_goal_type):<br>required: **false**<br>Filter goals by goal type<br>
10    ///   - [`limit(i32)`](crate::operation::list_goals::builders::ListGoalsFluentBuilder::limit) / [`set_limit(Option<i32>)`](crate::operation::list_goals::builders::ListGoalsFluentBuilder::set_limit):<br>required: **false**<br>Maximum number of goals to return<br>
11    ///   - [`next_token(impl Into<String>)`](crate::operation::list_goals::builders::ListGoalsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_goals::builders::ListGoalsFluentBuilder::set_next_token):<br>required: **false**<br>Pagination token for the next set of results<br>
12    /// - On success, responds with [`ListGoalsOutput`](crate::operation::list_goals::ListGoalsOutput) with field(s):
13    ///   - [`goals(Vec::<Goal>)`](crate::operation::list_goals::ListGoalsOutput::goals): List of goals matching the criteria
14    ///   - [`next_token(Option<String>)`](crate::operation::list_goals::ListGoalsOutput::next_token): Pagination token for the next set of results
15    /// - On failure, responds with [`SdkError<ListGoalsError>`](crate::operation::list_goals::ListGoalsError)
16    pub fn list_goals(&self) -> crate::operation::list_goals::builders::ListGoalsFluentBuilder {
17        crate::operation::list_goals::builders::ListGoalsFluentBuilder::new(self.handle.clone())
18    }
19}