Amazonka.Batch.Types.JobQueueDetail

Documentation

data JobQueueDetail

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

See: newJobQueueDetail smart constructor.

Constructors

JobQueueDetail'

Fields

• schedulingPolicyArn :: Maybe Text

  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 :: Maybe JQStatus

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

• statusReason :: Maybe Text

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

• tags :: Maybe (HashMap Text Text)

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

• jobQueueName :: Text

  The job queue name.

• jobQueueArn :: Text

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

• state :: 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.

• priority :: Int

  The priority of the job queue. Job queues with a higher priority (or a higher integer value for the priority parameter) are evaluated first when associated with the same compute environment. Priority is determined in descending order. For example, a job queue with a priority value of 10 is given scheduling preference over a job queue with a priority value of 1. All of the compute environments must be either EC2 (EC2 or SPOT) or Fargate (FARGATE or FARGATE_SPOT). EC2 and Fargate compute environments can't be mixed.

• computeEnvironmentOrder :: [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.

Instances

FromJSON JobQueueDetail

Defined in Amazonka.Batch.Types.JobQueueDetail

Methods

parseJSON :: Value -> Parser JobQueueDetail

parseJSONList :: Value -> Parser [JobQueueDetail]

Generic JobQueueDetail

Defined in Amazonka.Batch.Types.JobQueueDetail

Associated Types

type Rep JobQueueDetail :: Type -> Type

Methods

from :: JobQueueDetail -> Rep JobQueueDetail x

to :: Rep JobQueueDetail x -> JobQueueDetail

Read JobQueueDetail

Defined in Amazonka.Batch.Types.JobQueueDetail

Methods

readsPrec :: Int -> ReadS JobQueueDetail

readList :: ReadS [JobQueueDetail]

readPrec :: ReadPrec JobQueueDetail

readListPrec :: ReadPrec [JobQueueDetail]

Show JobQueueDetail

Defined in Amazonka.Batch.Types.JobQueueDetail

Methods

showsPrec :: Int -> JobQueueDetail -> ShowS

show :: JobQueueDetail -> String

showList :: [JobQueueDetail] -> ShowS

NFData JobQueueDetail

Defined in Amazonka.Batch.Types.JobQueueDetail

Methods

rnf :: JobQueueDetail -> ()

Eq JobQueueDetail

Defined in Amazonka.Batch.Types.JobQueueDetail

Methods

(==) :: JobQueueDetail -> JobQueueDetail -> Bool

(/=) :: JobQueueDetail -> JobQueueDetail -> Bool

Hashable JobQueueDetail

Defined in Amazonka.Batch.Types.JobQueueDetail

Methods

hashWithSalt :: Int -> JobQueueDetail -> Int

hash :: JobQueueDetail -> Int

type Rep JobQueueDetail

Defined in Amazonka.Batch.Types.JobQueueDetail

type Rep JobQueueDetail = D1 ('MetaData "JobQueueDetail" "Amazonka.Batch.Types.JobQueueDetail" "amazonka-batch-2.0-Ey2VZ5obnq65VwmlrJ2r2K" 'False) (C1 ('MetaCons "JobQueueDetail'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "schedulingPolicyArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe JQStatus))) :*: (S1 ('MetaSel ('Just "statusReason") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))))) :*: ((S1 ('MetaSel ('Just "jobQueueName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "jobQueueArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "state") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 JQState) :*: (S1 ('MetaSel ('Just "priority") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "computeEnvironmentOrder") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [ComputeEnvironmentOrder]))))))

newJobQueueDetail

Arguments

:: Text

$sel:jobQueueName:JobQueueDetail'

-> Text

$sel:jobQueueArn:JobQueueDetail'

-> JQState

$sel:state:JobQueueDetail'

-> Int

$sel:priority:JobQueueDetail'

-> JobQueueDetail

Create a value of JobQueueDetail with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:schedulingPolicyArn:JobQueueDetail', jobQueueDetail_schedulingPolicyArn - 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.

$sel:status:JobQueueDetail', jobQueueDetail_status - The status of the job queue (for example, CREATING or VALID).

$sel:statusReason:JobQueueDetail', jobQueueDetail_statusReason - A short, human-readable string to provide additional details for the current status of the job queue.

$sel:tags:JobQueueDetail', jobQueueDetail_tags - The tags that are applied to the job queue. For more information, see Tagging your Batch resources in Batch User Guide.

$sel:jobQueueName:JobQueueDetail', jobQueueDetail_jobQueueName - The job queue name.

$sel:jobQueueArn:JobQueueDetail', jobQueueDetail_jobQueueArn - The Amazon Resource Name (ARN) of the job queue.

$sel:state:JobQueueDetail', jobQueueDetail_state - 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.

$sel:priority:JobQueueDetail', jobQueueDetail_priority - The priority of the job queue. Job queues with a higher priority (or a higher integer value for the priority parameter) are evaluated first when associated with the same compute environment. Priority is determined in descending order. For example, a job queue with a priority value of 10 is given scheduling preference over a job queue with a priority value of 1. All of the compute environments must be either EC2 (EC2 or SPOT) or Fargate (FARGATE or FARGATE_SPOT). EC2 and Fargate compute environments can't be mixed.

$sel:computeEnvironmentOrder:JobQueueDetail', jobQueueDetail_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.

jobQueueDetail_schedulingPolicyArn :: Lens' JobQueueDetail (Maybe Text)

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.

jobQueueDetail_status :: Lens' JobQueueDetail (Maybe JQStatus)

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

jobQueueDetail_statusReason :: Lens' JobQueueDetail (Maybe Text)

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

jobQueueDetail_tags :: Lens' JobQueueDetail (Maybe (HashMap Text Text))

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

jobQueueDetail_jobQueueName :: Lens' JobQueueDetail Text

The job queue name.

jobQueueDetail_jobQueueArn :: Lens' JobQueueDetail Text

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

jobQueueDetail_state :: Lens' JobQueueDetail 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.

jobQueueDetail_priority :: Lens' JobQueueDetail Int

The priority of the job queue. Job queues with a higher priority (or a higher integer value for the priority parameter) are evaluated first when associated with the same compute environment. Priority is determined in descending order. For example, a job queue with a priority value of 10 is given scheduling preference over a job queue with a priority value of 1. All of the compute environments must be either EC2 (EC2 or SPOT) or Fargate (FARGATE or FARGATE_SPOT). EC2 and Fargate compute environments can't be mixed.

jobQueueDetail_computeEnvironmentOrder :: Lens' JobQueueDetail [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.