aws_sdk_batch/client/

list_jobs_by_consumable_resource.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`ListJobsByConsumableResource`](crate::operation::list_jobs_by_consumable_resource::builders::ListJobsByConsumableResourceFluentBuilder) operation.
    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_jobs_by_consumable_resource::builders::ListJobsByConsumableResourceFluentBuilder::into_paginator).
    ///
    /// - The fluent builder is configurable:
    ///   - [`consumable_resource(impl Into<String>)`](crate::operation::list_jobs_by_consumable_resource::builders::ListJobsByConsumableResourceFluentBuilder::consumable_resource) / [`set_consumable_resource(Option<String>)`](crate::operation::list_jobs_by_consumable_resource::builders::ListJobsByConsumableResourceFluentBuilder::set_consumable_resource):<br>required: **true**<br><p>The name or ARN of the consumable resource.</p><br>
    ///   - [`filters(KeyValuesPair)`](crate::operation::list_jobs_by_consumable_resource::builders::ListJobsByConsumableResourceFluentBuilder::filters) / [`set_filters(Option<Vec::<KeyValuesPair>>)`](crate::operation::list_jobs_by_consumable_resource::builders::ListJobsByConsumableResourceFluentBuilder::set_filters):<br>required: **false**<br><p>The filters to apply to the job list query. If used, only those jobs requiring the specified consumable resource (<code>consumableResource</code>) and that match the value of the filters are listed. The filter names and values can be:</p> <ul>  <li>   <p>name: <code>JOB_STATUS</code></p>   <p>values: <code>SUBMITTED | PENDING | RUNNABLE | STARTING | RUNNING | SUCCEEDED | FAILED</code></p></li>  <li>   <p>name: <code>JOB_NAME </code></p>   <p>The values are case-insensitive matches for the job name. If a filter value ends with an asterisk (*), it matches any job name that begins with the string before the '*'.</p></li> </ul><br>
    ///   - [`max_results(i32)`](crate::operation::list_jobs_by_consumable_resource::builders::ListJobsByConsumableResourceFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_jobs_by_consumable_resource::builders::ListJobsByConsumableResourceFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of results returned by <code>ListJobsByConsumableResource</code> in paginated output. When this parameter is used, <code>ListJobsByConsumableResource</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>ListJobsByConsumableResource</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>ListJobsByConsumableResource</code> returns up to 100 results and a <code>nextToken</code> value if applicable.</p><br>
    ///   - [`next_token(impl Into<String>)`](crate::operation::list_jobs_by_consumable_resource::builders::ListJobsByConsumableResourceFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_jobs_by_consumable_resource::builders::ListJobsByConsumableResourceFluentBuilder::set_next_token):<br>required: **false**<br><p>The <code>nextToken</code> value returned from a previous paginated <code>ListJobsByConsumableResource</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>
    /// - On success, responds with [`ListJobsByConsumableResourceOutput`](crate::operation::list_jobs_by_consumable_resource::ListJobsByConsumableResourceOutput) with field(s):
    ///   - [`jobs(Option<Vec::<ListJobsByConsumableResourceSummary>>)`](crate::operation::list_jobs_by_consumable_resource::ListJobsByConsumableResourceOutput::jobs): <p>The list of jobs that require the specified consumable resources.</p>
    ///   - [`next_token(Option<String>)`](crate::operation::list_jobs_by_consumable_resource::ListJobsByConsumableResourceOutput::next_token): <p>The <code>nextToken</code> value to include in a future <code>ListJobsByConsumableResource</code> request. When the results of a <code>ListJobsByConsumableResource</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<ListJobsByConsumableResourceError>`](crate::operation::list_jobs_by_consumable_resource::ListJobsByConsumableResourceError)
    pub fn list_jobs_by_consumable_resource(
        &self,
    ) -> crate::operation::list_jobs_by_consumable_resource::builders::ListJobsByConsumableResourceFluentBuilder {
        crate::operation::list_jobs_by_consumable_resource::builders::ListJobsByConsumableResourceFluentBuilder::new(self.handle.clone())
    }
}