aws_sdk_devopsagent/client/list_backlog_tasks.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 [`ListBacklogTasks`](crate::operation::list_backlog_tasks::builders::ListBacklogTasksFluentBuilder) operation.
4 /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_backlog_tasks::builders::ListBacklogTasksFluentBuilder::into_paginator).
5 ///
6 /// - The fluent builder is configurable:
7 /// - [`agent_space_id(impl Into<String>)`](crate::operation::list_backlog_tasks::builders::ListBacklogTasksFluentBuilder::agent_space_id) / [`set_agent_space_id(Option<String>)`](crate::operation::list_backlog_tasks::builders::ListBacklogTasksFluentBuilder::set_agent_space_id):<br>required: **true**<br>The unique identifier for the agent space containing the tasks<br>
8 /// - [`filter(TaskFilter)`](crate::operation::list_backlog_tasks::builders::ListBacklogTasksFluentBuilder::filter) / [`set_filter(Option<TaskFilter>)`](crate::operation::list_backlog_tasks::builders::ListBacklogTasksFluentBuilder::set_filter):<br>required: **false**<br>Filter criteria to apply when listing tasks Filtering restrictions: - Each filter field list is limited to a single value - Filtering by Priority and Status at the same time when not filtering by Type is not permitted - Timestamp filters (createdAfter, createdBefore) can be combined with other filters when not sorting by priority<br>
9 /// - [`limit(i32)`](crate::operation::list_backlog_tasks::builders::ListBacklogTasksFluentBuilder::limit) / [`set_limit(Option<i32>)`](crate::operation::list_backlog_tasks::builders::ListBacklogTasksFluentBuilder::set_limit):<br>required: **false**<br>Maximum number of tasks to return in a single response (1-1000, default: 100)<br>
10 /// - [`next_token(impl Into<String>)`](crate::operation::list_backlog_tasks::builders::ListBacklogTasksFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_backlog_tasks::builders::ListBacklogTasksFluentBuilder::set_next_token):<br>required: **false**<br>Token for retrieving the next page of results<br>
11 /// - [`sort_field(TaskSortField)`](crate::operation::list_backlog_tasks::builders::ListBacklogTasksFluentBuilder::sort_field) / [`set_sort_field(Option<TaskSortField>)`](crate::operation::list_backlog_tasks::builders::ListBacklogTasksFluentBuilder::set_sort_field):<br>required: **false**<br>Field to sort by Sorting restrictions: - Only sorting on createdAt is supported when using priority or status filters alone. - Sorting by priority is not supported when using Timestamp filters (createdAfter, createdBefore)<br>
12 /// - [`order(TaskSortOrder)`](crate::operation::list_backlog_tasks::builders::ListBacklogTasksFluentBuilder::order) / [`set_order(Option<TaskSortOrder>)`](crate::operation::list_backlog_tasks::builders::ListBacklogTasksFluentBuilder::set_order):<br>required: **false**<br>Sort order for the tasks based on sortField (default: DESC)<br>
13 /// - On success, responds with [`ListBacklogTasksOutput`](crate::operation::list_backlog_tasks::ListBacklogTasksOutput) with field(s):
14 /// - [`tasks(Vec::<Task>)`](crate::operation::list_backlog_tasks::ListBacklogTasksOutput::tasks): List of backlog tasks
15 /// - [`next_token(Option<String>)`](crate::operation::list_backlog_tasks::ListBacklogTasksOutput::next_token): Token for retrieving the next page of results, if more results are available
16 /// - On failure, responds with [`SdkError<ListBacklogTasksError>`](crate::operation::list_backlog_tasks::ListBacklogTasksError)
17 pub fn list_backlog_tasks(&self) -> crate::operation::list_backlog_tasks::builders::ListBacklogTasksFluentBuilder {
18 crate::operation::list_backlog_tasks::builders::ListBacklogTasksFluentBuilder::new(self.handle.clone())
19 }
20}