aws_sdk_batch/client/

list_service_jobs.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`ListServiceJobs`](crate::operation::list_service_jobs::builders::ListServiceJobsFluentBuilder) operation.
    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_service_jobs::builders::ListServiceJobsFluentBuilder::into_paginator).
    ///
    /// - The fluent builder is configurable:
    ///   - [`job_queue(impl Into<String>)`](crate::operation::list_service_jobs::builders::ListServiceJobsFluentBuilder::job_queue) / [`set_job_queue(Option<String>)`](crate::operation::list_service_jobs::builders::ListServiceJobsFluentBuilder::set_job_queue):<br>required: **false**<br><p>The name or ARN of the job queue with which to list service jobs.</p><br>
    ///   - [`job_status(ServiceJobStatus)`](crate::operation::list_service_jobs::builders::ListServiceJobsFluentBuilder::job_status) / [`set_job_status(Option<ServiceJobStatus>)`](crate::operation::list_service_jobs::builders::ListServiceJobsFluentBuilder::set_job_status):<br>required: **false**<br><p>The job status with which to filter service jobs.</p><br>
    ///   - [`max_results(i32)`](crate::operation::list_service_jobs::builders::ListServiceJobsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_service_jobs::builders::ListServiceJobsFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of results returned by <code>ListServiceJobs</code> in paginated output. When this parameter is used, <code>ListServiceJobs</code> only returns <code>maxResults</code> results in a single page and a <code>nextToken</code> response element. The remaining results of the initial request can be seen by sending another <code>ListServiceJobs</code> request with the returned <code>nextToken</code> value. This value can be between 1 and 100. If this parameter isn't used, then <code>ListServiceJobs</code> returns up to 100 results and a <code>nextToken</code> value if applicable.</p><br>
    ///   - [`next_token(impl Into<String>)`](crate::operation::list_service_jobs::builders::ListServiceJobsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_service_jobs::builders::ListServiceJobsFluentBuilder::set_next_token):<br>required: **false**<br><p>The <code>nextToken</code> value returned from a previous paginated <code>ListServiceJobs</code> request where <code>maxResults</code> was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the <code>nextToken</code> value. This value is <code>null</code> when there are no more results to return.</p><note>  <p>Treat this token as an opaque identifier that's only used to retrieve the next items in a list and not for other programmatic purposes.</p> </note><br>
    ///   - [`filters(KeyValuesPair)`](crate::operation::list_service_jobs::builders::ListServiceJobsFluentBuilder::filters) / [`set_filters(Option<Vec::<KeyValuesPair>>)`](crate::operation::list_service_jobs::builders::ListServiceJobsFluentBuilder::set_filters):<br>required: **false**<br><p>The filter to apply to the query. Only one filter can be used at a time. When the filter is used, <code>jobStatus</code> is ignored. The results are sorted by the <code>createdAt</code> field, with the most recent jobs being first.</p> <dl>  <dt>   JOB_NAME  </dt>  <dd>   <p>The value of the filter is a case-insensitive match for the job name. If the value ends with an asterisk (*), the filter matches any job name that begins with the string before the '*'. This corresponds to the <code>jobName</code> value. For example, <code>test1</code> matches both <code>Test1</code> and <code>test1</code>, and <code>test1*</code> matches both <code>test1</code> and <code>Test10</code>. When the <code>JOB_NAME</code> filter is used, the results are grouped by the job name and version.</p>  </dd>  <dt>   BEFORE_CREATED_AT  </dt>  <dd>   <p>The value for the filter is the time that's before the job was created. This corresponds to the <code>createdAt</code> value. The value is a string representation of the number of milliseconds since 00:00:00 UTC (midnight) on January 1, 1970.</p>  </dd>  <dt>   AFTER_CREATED_AT  </dt>  <dd>   <p>The value for the filter is the time that's after the job was created. This corresponds to the <code>createdAt</code> value. The value is a string representation of the number of milliseconds since 00:00:00 UTC (midnight) on January 1, 1970.</p>  </dd> </dl><br>
    /// - On success, responds with [`ListServiceJobsOutput`](crate::operation::list_service_jobs::ListServiceJobsOutput) with field(s):
    ///   - [`job_summary_list(Option<Vec::<ServiceJobSummary>>)`](crate::operation::list_service_jobs::ListServiceJobsOutput::job_summary_list): <p>A list of service job summaries.</p>
    ///   - [`next_token(Option<String>)`](crate::operation::list_service_jobs::ListServiceJobsOutput::next_token): <p>The <code>nextToken</code> value to include in a future <code>ListServiceJobs</code> request. When the results of a <code>ListServiceJobs</code> request exceed <code>maxResults</code>, this value can be used to retrieve the next page of results. This value is <code>null</code> when there are no more results to return.</p>
    /// - On failure, responds with [`SdkError<ListServiceJobsError>`](crate::operation::list_service_jobs::ListServiceJobsError)
    pub fn list_service_jobs(&self) -> crate::operation::list_service_jobs::builders::ListServiceJobsFluentBuilder {
        crate::operation::list_service_jobs::builders::ListServiceJobsFluentBuilder::new(self.handle.clone())
    }
}