aws_sdk_deadline/client/
list_jobs.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 [`ListJobs`](crate::operation::list_jobs::builders::ListJobsFluentBuilder) operation.
    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_jobs::builders::ListJobsFluentBuilder::into_paginator).
    ///
    /// - The fluent builder is configurable:
    ///   - [`farm_id(impl Into<String>)`](crate::operation::list_jobs::builders::ListJobsFluentBuilder::farm_id) / [`set_farm_id(Option<String>)`](crate::operation::list_jobs::builders::ListJobsFluentBuilder::set_farm_id):<br>required: **true**<br><p>The farm ID for the jobs.</p><br>
    ///   - [`principal_id(impl Into<String>)`](crate::operation::list_jobs::builders::ListJobsFluentBuilder::principal_id) / [`set_principal_id(Option<String>)`](crate::operation::list_jobs::builders::ListJobsFluentBuilder::set_principal_id):<br>required: **false**<br><p>The principal ID of the members on the jobs.</p><br>
    ///   - [`queue_id(impl Into<String>)`](crate::operation::list_jobs::builders::ListJobsFluentBuilder::queue_id) / [`set_queue_id(Option<String>)`](crate::operation::list_jobs::builders::ListJobsFluentBuilder::set_queue_id):<br>required: **true**<br><p>The queue ID for the job.</p><br>
    ///   - [`next_token(impl Into<String>)`](crate::operation::list_jobs::builders::ListJobsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_jobs::builders::ListJobsFluentBuilder::set_next_token):<br>required: **false**<br><p>The token for the next set of results, or <code>null</code> to start from the beginning.</p><br>
    ///   - [`max_results(i32)`](crate::operation::list_jobs::builders::ListJobsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_jobs::builders::ListJobsFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of results to return. Use this parameter with <code>NextToken</code> to get results as a set of sequential pages.</p><br>
    /// - On success, responds with [`ListJobsOutput`](crate::operation::list_jobs::ListJobsOutput) with field(s):
    ///   - [`jobs(Vec::<JobSummary>)`](crate::operation::list_jobs::ListJobsOutput::jobs): <p>The jobs on the list.</p>
    ///   - [`next_token(Option<String>)`](crate::operation::list_jobs::ListJobsOutput::next_token): <p>If Deadline Cloud returns <code>nextToken</code>, then there are more results available. The value of <code>nextToken</code> is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, then <code>nextToken</code> is set to <code>null</code>. Each pagination token expires after 24 hours. If you provide a token that isn't valid, then you receive an HTTP 400 <code>ValidationException</code> error.</p>
    /// - On failure, responds with [`SdkError<ListJobsError>`](crate::operation::list_jobs::ListJobsError)
    pub fn list_jobs(&self) -> crate::operation::list_jobs::builders::ListJobsFluentBuilder {
        crate::operation::list_jobs::builders::ListJobsFluentBuilder::new(self.handle.clone())
    }
}