aws_sdk_batch/client/
get_job_queue_snapshot.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 [`GetJobQueueSnapshot`](crate::operation::get_job_queue_snapshot::builders::GetJobQueueSnapshotFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`job_queue(impl Into<String>)`](crate::operation::get_job_queue_snapshot::builders::GetJobQueueSnapshotFluentBuilder::job_queue) / [`set_job_queue(Option<String>)`](crate::operation::get_job_queue_snapshot::builders::GetJobQueueSnapshotFluentBuilder::set_job_queue):<br>required: **true**<br><p>The job queue’s name or full queue Amazon Resource Name (ARN).</p><br>
7    /// - On success, responds with [`GetJobQueueSnapshotOutput`](crate::operation::get_job_queue_snapshot::GetJobQueueSnapshotOutput) with field(s):
8    ///   - [`front_of_queue(Option<FrontOfQueueDetail>)`](crate::operation::get_job_queue_snapshot::GetJobQueueSnapshotOutput::front_of_queue): <p>The list of the first 100 <code>RUNNABLE</code> jobs in each job queue. For first-in-first-out (FIFO) job queues, jobs are ordered based on their submission time. For fair-share scheduling (FSS) job queues, jobs are ordered based on their job priority and share usage.</p>
9    /// - On failure, responds with [`SdkError<GetJobQueueSnapshotError>`](crate::operation::get_job_queue_snapshot::GetJobQueueSnapshotError)
10    pub fn get_job_queue_snapshot(&self) -> crate::operation::get_job_queue_snapshot::builders::GetJobQueueSnapshotFluentBuilder {
11        crate::operation::get_job_queue_snapshot::builders::GetJobQueueSnapshotFluentBuilder::new(self.handle.clone())
12    }
13}