Struct JobQueueDetail

#[non_exhaustive]
pub struct JobQueueDetail {
    pub job_queue_name: Option<String>,
    pub job_queue_arn: Option<String>,
    pub state: Option<JqState>,
    pub scheduling_policy_arn: Option<String>,
    pub status: Option<JqStatus>,
    pub status_reason: Option<String>,
    pub priority: Option<i32>,
    pub compute_environment_order: Option<Vec<ComputeEnvironmentOrder>>,
    pub tags: Option<HashMap<String, String>>,
    pub job_state_time_limit_actions: Option<Vec<JobStateTimeLimitAction>>,
}

An object that represents the details for an Batch job queue.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

job_queue_name: Option<String>

The job queue name.

job_queue_arn: Option<String>

The Amazon Resource Name (ARN) of the job queue.

state: Option<JqState>

Describes the ability of the queue to accept new jobs. If the job queue state is ENABLED, it can accept jobs. If the job queue state is DISABLED, new jobs can't be added to the queue, but jobs already in the queue can finish.

scheduling_policy_arn: Option<String>

The Amazon Resource Name (ARN) of the scheduling policy. The format is aws:Partition:batch:Region:Account:scheduling-policy/Name . For example, aws:aws:batch:us-west-2:123456789012:scheduling-policy/MySchedulingPolicy.

status: Option<JqStatus>

The status of the job queue (for example, CREATING or VALID).

status_reason: Option<String>

A short, human-readable string to provide additional details for the current status of the job queue.

priority: Option<i32>

The priority of the job queue. Job queue priority determines the order that job queues are evaluated when multiple queues dispatch jobs within a shared compute environment. A higher value for priority indicates a higher priority. Queues are evaluated in cycles, in descending order by priority. For example, a job queue with a priority value of 10 is evaluated before a queue with a priority value of 1. All of the compute environments must be either Amazon EC2 (EC2 or SPOT) or Fargate (FARGATE or FARGATE_SPOT). Amazon EC2 and Fargate compute environments can't be mixed.

Job queue priority doesn't guarantee that a particular job executes before a job in a lower priority queue. Jobs added to higher priority queues during the queue evaluation cycle might not be evaluated until the next cycle. A job is dispatched from a queue only if resources are available when the queue is evaluated. If there are insufficient resources available at that time, the cycle proceeds to the next queue. This means that jobs added to higher priority queues might have to wait for jobs in multiple lower priority queues to complete before they are dispatched. You can use job dependencies to control the order for jobs from queues with different priorities. For more information, see Job Dependencies in the Batch User Guide.

compute_environment_order: Option<Vec<ComputeEnvironmentOrder>>

The compute environments that are attached to the job queue and the order that job placement is preferred. Compute environments are selected for job placement in ascending order.

tags: Option<HashMap<String, String>>

The tags that are applied to the job queue. For more information, see Tagging your Batch resources in Batch User Guide.

job_state_time_limit_actions: Option<Vec<JobStateTimeLimitAction>>

The set of actions that Batch perform on jobs that remain at the head of the job queue in the specified state longer than specified times. Batch will perform each action after maxTimeSeconds has passed.

Implementations

impl JobQueueDetail

pub fn job_queue_name(&self) -> Option<&str>

The job queue name.

pub fn job_queue_arn(&self) -> Option<&str>

The Amazon Resource Name (ARN) of the job queue.

pub fn state(&self) -> Option<&JqState>

Describes the ability of the queue to accept new jobs. If the job queue state is ENABLED, it can accept jobs. If the job queue state is DISABLED, new jobs can't be added to the queue, but jobs already in the queue can finish.

pub fn scheduling_policy_arn(&self) -> Option<&str>

The Amazon Resource Name (ARN) of the scheduling policy. The format is aws:Partition:batch:Region:Account:scheduling-policy/Name . For example, aws:aws:batch:us-west-2:123456789012:scheduling-policy/MySchedulingPolicy.

pub fn status(&self) -> Option<&JqStatus>

The status of the job queue (for example, CREATING or VALID).

pub fn status_reason(&self) -> Option<&str>

A short, human-readable string to provide additional details for the current status of the job queue.

pub fn priority(&self) -> Option<i32>

The priority of the job queue. Job queue priority determines the order that job queues are evaluated when multiple queues dispatch jobs within a shared compute environment. A higher value for priority indicates a higher priority. Queues are evaluated in cycles, in descending order by priority. For example, a job queue with a priority value of 10 is evaluated before a queue with a priority value of 1. All of the compute environments must be either Amazon EC2 (EC2 or SPOT) or Fargate (FARGATE or FARGATE_SPOT). Amazon EC2 and Fargate compute environments can't be mixed.

Job queue priority doesn't guarantee that a particular job executes before a job in a lower priority queue. Jobs added to higher priority queues during the queue evaluation cycle might not be evaluated until the next cycle. A job is dispatched from a queue only if resources are available when the queue is evaluated. If there are insufficient resources available at that time, the cycle proceeds to the next queue. This means that jobs added to higher priority queues might have to wait for jobs in multiple lower priority queues to complete before they are dispatched. You can use job dependencies to control the order for jobs from queues with different priorities. For more information, see Job Dependencies in the Batch User Guide.

pub fn compute_environment_order(&self) -> &[ComputeEnvironmentOrder]

The compute environments that are attached to the job queue and the order that job placement is preferred. Compute environments are selected for job placement in ascending order.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .compute_environment_order.is_none().

pub fn tags(&self) -> Option<&HashMap<String, String>>

The tags that are applied to the job queue. For more information, see Tagging your Batch resources in Batch User Guide.

pub fn job_state_time_limit_actions(&self) -> &[JobStateTimeLimitAction]

The set of actions that Batch perform on jobs that remain at the head of the job queue in the specified state longer than specified times. Batch will perform each action after maxTimeSeconds has passed.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .job_state_time_limit_actions.is_none().

impl JobQueueDetail

pub fn builder() -> JobQueueDetailBuilder

Creates a new builder-style object to manufacture JobQueueDetail.

Trait Implementations

impl Clone for JobQueueDetail

fn clone(&self) -> JobQueueDetail

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for JobQueueDetail

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for JobQueueDetail

fn eq(&self, other: &JobQueueDetail) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for JobQueueDetail