aws_sdk_elastictranscoder/client/

list_jobs_by_status.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`ListJobsByStatus`](crate::operation::list_jobs_by_status::builders::ListJobsByStatusFluentBuilder) operation.
    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_jobs_by_status::builders::ListJobsByStatusFluentBuilder::into_paginator).
    ///
    /// - The fluent builder is configurable:
    ///   - [`status(impl Into<String>)`](crate::operation::list_jobs_by_status::builders::ListJobsByStatusFluentBuilder::status) / [`set_status(Option<String>)`](crate::operation::list_jobs_by_status::builders::ListJobsByStatusFluentBuilder::set_status):<br>required: **true**<br><p>To get information about all of the jobs associated with the current AWS account that have a given status, specify the following status: <code>Submitted</code>, <code>Progressing</code>, <code>Complete</code>, <code>Canceled</code>, or <code>Error</code>.</p><br>
    ///   - [`ascending(impl Into<String>)`](crate::operation::list_jobs_by_status::builders::ListJobsByStatusFluentBuilder::ascending) / [`set_ascending(Option<String>)`](crate::operation::list_jobs_by_status::builders::ListJobsByStatusFluentBuilder::set_ascending):<br>required: **false**<br><p>To list jobs in chronological order by the date and time that they were submitted, enter <code>true</code>. To list jobs in reverse chronological order, enter <code>false</code>.</p><br>
    ///   - [`page_token(impl Into<String>)`](crate::operation::list_jobs_by_status::builders::ListJobsByStatusFluentBuilder::page_token) / [`set_page_token(Option<String>)`](crate::operation::list_jobs_by_status::builders::ListJobsByStatusFluentBuilder::set_page_token):<br>required: **false**<br><p>When Elastic Transcoder returns more than one page of results, use <code>pageToken</code> in subsequent <code>GET</code> requests to get each successive page of results.</p><br>
    /// - On success, responds with [`ListJobsByStatusOutput`](crate::operation::list_jobs_by_status::ListJobsByStatusOutput) with field(s):
    ///   - [`jobs(Option<Vec::<Job>>)`](crate::operation::list_jobs_by_status::ListJobsByStatusOutput::jobs): <p>An array of <code>Job</code> objects that have the specified status.</p>
    ///   - [`next_page_token(Option<String>)`](crate::operation::list_jobs_by_status::ListJobsByStatusOutput::next_page_token): <p>A value that you use to access the second and subsequent pages of results, if any. When the jobs in the specified pipeline fit on one page or when you've reached the last page of results, the value of <code>NextPageToken</code> is <code>null</code>.</p>
    /// - On failure, responds with [`SdkError<ListJobsByStatusError>`](crate::operation::list_jobs_by_status::ListJobsByStatusError)
    pub fn list_jobs_by_status(&self) -> crate::operation::list_jobs_by_status::builders::ListJobsByStatusFluentBuilder {
        crate::operation::list_jobs_by_status::builders::ListJobsByStatusFluentBuilder::new(self.handle.clone())
    }
}