Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Creates an Batch job queue. When you create a job queue, you associate one or more compute environments to the queue and assign an order of preference for the compute environments.
You also set a priority to the job queue that determines the order that the Batch scheduler places jobs onto its associated compute environments. For example, if a compute environment is associated with more than one job queue, the job queue with a higher priority is given preference for scheduling jobs to that compute environment.
Synopsis
- data CreateJobQueue = CreateJobQueue' {}
- newCreateJobQueue :: Text -> Int -> CreateJobQueue
- createJobQueue_schedulingPolicyArn :: Lens' CreateJobQueue (Maybe Text)
- createJobQueue_state :: Lens' CreateJobQueue (Maybe JQState)
- createJobQueue_tags :: Lens' CreateJobQueue (Maybe (HashMap Text Text))
- createJobQueue_jobQueueName :: Lens' CreateJobQueue Text
- createJobQueue_priority :: Lens' CreateJobQueue Int
- createJobQueue_computeEnvironmentOrder :: Lens' CreateJobQueue [ComputeEnvironmentOrder]
- data CreateJobQueueResponse = CreateJobQueueResponse' {
- httpStatus :: Int
- jobQueueName :: Text
- jobQueueArn :: Text
- newCreateJobQueueResponse :: Int -> Text -> Text -> CreateJobQueueResponse
- createJobQueueResponse_httpStatus :: Lens' CreateJobQueueResponse Int
- createJobQueueResponse_jobQueueName :: Lens' CreateJobQueueResponse Text
- createJobQueueResponse_jobQueueArn :: Lens' CreateJobQueueResponse Text
Creating a Request
data CreateJobQueue Source #
Contains the parameters for CreateJobQueue
.
See: newCreateJobQueue
smart constructor.
CreateJobQueue' | |
|
Instances
Create a value of CreateJobQueue
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:
CreateJobQueue
, createJobQueue_schedulingPolicyArn
- The Amazon Resource Name (ARN) of the fair share scheduling policy. If
this parameter is specified, the job queue uses a fair share scheduling
policy. If this parameter isn't specified, the job queue uses a first
in, first out (FIFO) scheduling policy. After a job queue is created,
you can replace but can't remove the fair share scheduling policy. The
format is
aws:
Partition
:batch:
Region
:
Account
:scheduling-policy/
Name
.
An example is
aws:aws:batch:us-west-2:123456789012:scheduling-policy/MySchedulingPolicy
.
CreateJobQueue
, createJobQueue_state
- The state of the job queue. If the job queue state is ENABLED
, it is
able to 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.
CreateJobQueue
, createJobQueue_tags
- The tags that you apply to the job queue to help you categorize and
organize your resources. Each tag consists of a key and an optional
value. For more information, see
Tagging your Batch resources
in Batch User Guide.
CreateJobQueue
, createJobQueue_jobQueueName
- The name of the job queue. It can be up to 128 letters long. It can
contain uppercase and lowercase letters, numbers, hyphens (-), and
underscores (_).
CreateJobQueue
, createJobQueue_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.
CreateJobQueue
, createJobQueue_computeEnvironmentOrder
- The set of compute environments mapped to a job queue and their order
relative to each other. The job scheduler uses this parameter to
determine which compute environment runs a specific job. Compute
environments must be in the VALID
state before you can associate them
with a job queue. You can associate up to three compute environments
with a job queue. 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.
All compute environments that are associated with a job queue must share the same architecture. Batch doesn't support mixing compute environment architecture types in a single job queue.
Request Lenses
createJobQueue_schedulingPolicyArn :: Lens' CreateJobQueue (Maybe Text) Source #
The Amazon Resource Name (ARN) of the fair share scheduling policy. If
this parameter is specified, the job queue uses a fair share scheduling
policy. If this parameter isn't specified, the job queue uses a first
in, first out (FIFO) scheduling policy. After a job queue is created,
you can replace but can't remove the fair share scheduling policy. The
format is
aws:
Partition
:batch:
Region
:
Account
:scheduling-policy/
Name
.
An example is
aws:aws:batch:us-west-2:123456789012:scheduling-policy/MySchedulingPolicy
.
createJobQueue_state :: Lens' CreateJobQueue (Maybe JQState) Source #
The state of the job queue. If the job queue state is ENABLED
, it is
able to 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.
createJobQueue_tags :: Lens' CreateJobQueue (Maybe (HashMap Text Text)) Source #
The tags that you apply to the job queue to help you categorize and organize your resources. Each tag consists of a key and an optional value. For more information, see Tagging your Batch resources in Batch User Guide.
createJobQueue_jobQueueName :: Lens' CreateJobQueue Text Source #
The name of the job queue. It can be up to 128 letters long. It can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).
createJobQueue_priority :: Lens' CreateJobQueue Int Source #
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.
createJobQueue_computeEnvironmentOrder :: Lens' CreateJobQueue [ComputeEnvironmentOrder] Source #
The set of compute environments mapped to a job queue and their order
relative to each other. The job scheduler uses this parameter to
determine which compute environment runs a specific job. Compute
environments must be in the VALID
state before you can associate them
with a job queue. You can associate up to three compute environments
with a job queue. 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.
All compute environments that are associated with a job queue must share the same architecture. Batch doesn't support mixing compute environment architecture types in a single job queue.
Destructuring the Response
data CreateJobQueueResponse Source #
See: newCreateJobQueueResponse
smart constructor.
CreateJobQueueResponse' | |
|
Instances
newCreateJobQueueResponse Source #
:: Int | |
-> Text | |
-> Text | |
-> CreateJobQueueResponse |
Create a value of CreateJobQueueResponse
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:httpStatus:CreateJobQueueResponse'
, createJobQueueResponse_httpStatus
- The response's http status code.
CreateJobQueue
, createJobQueueResponse_jobQueueName
- The name of the job queue.
CreateJobQueueResponse
, createJobQueueResponse_jobQueueArn
- The Amazon Resource Name (ARN) of the job queue.
Response Lenses
createJobQueueResponse_httpStatus :: Lens' CreateJobQueueResponse Int Source #
The response's http status code.
createJobQueueResponse_jobQueueName :: Lens' CreateJobQueueResponse Text Source #
The name of the job queue.
createJobQueueResponse_jobQueueArn :: Lens' CreateJobQueueResponse Text Source #
The Amazon Resource Name (ARN) of the job queue.