Amazonka.Batch.CreateJobQueue

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.

Creating a Request

data CreateJobQueue

Contains the parameters for CreateJobQueue.

See: newCreateJobQueue smart constructor.

Constructors

CreateJobQueue'

Fields

• schedulingPolicyArn :: Maybe Text

  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.

• state :: Maybe JQState

  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.

• tags :: Maybe (HashMap Text Text)

  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.

• jobQueueName :: Text

  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 (_).

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

Instances

ToJSON CreateJobQueue

Defined in Amazonka.Batch.CreateJobQueue

Methods

toJSON :: CreateJobQueue -> Value

toEncoding :: CreateJobQueue -> Encoding

toJSONList :: [CreateJobQueue] -> Value

toEncodingList :: [CreateJobQueue] -> Encoding

ToHeaders CreateJobQueue

Defined in Amazonka.Batch.CreateJobQueue

Methods

toHeaders :: CreateJobQueue -> [Header]

ToPath CreateJobQueue

Defined in Amazonka.Batch.CreateJobQueue

Methods

toPath :: CreateJobQueue -> ByteString

ToQuery CreateJobQueue

Defined in Amazonka.Batch.CreateJobQueue

Methods

toQuery :: CreateJobQueue -> QueryString

AWSRequest CreateJobQueue

Defined in Amazonka.Batch.CreateJobQueue

Associated Types

type AWSResponse CreateJobQueue

Methods

request :: (Service -> Service) -> CreateJobQueue -> Request CreateJobQueue

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateJobQueue -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateJobQueue)))

Generic CreateJobQueue

Defined in Amazonka.Batch.CreateJobQueue

Associated Types

type Rep CreateJobQueue :: Type -> Type

Methods

from :: CreateJobQueue -> Rep CreateJobQueue x

to :: Rep CreateJobQueue x -> CreateJobQueue

Read CreateJobQueue

Defined in Amazonka.Batch.CreateJobQueue

Methods

readsPrec :: Int -> ReadS CreateJobQueue

readList :: ReadS [CreateJobQueue]

readPrec :: ReadPrec CreateJobQueue

readListPrec :: ReadPrec [CreateJobQueue]

Show CreateJobQueue

Defined in Amazonka.Batch.CreateJobQueue

Methods

showsPrec :: Int -> CreateJobQueue -> ShowS

show :: CreateJobQueue -> String

showList :: [CreateJobQueue] -> ShowS

NFData CreateJobQueue

Defined in Amazonka.Batch.CreateJobQueue

Methods

rnf :: CreateJobQueue -> ()

Eq CreateJobQueue

Defined in Amazonka.Batch.CreateJobQueue

Methods

(==) :: CreateJobQueue -> CreateJobQueue -> Bool

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

Hashable CreateJobQueue

Defined in Amazonka.Batch.CreateJobQueue

Methods

hashWithSalt :: Int -> CreateJobQueue -> Int

hash :: CreateJobQueue -> Int

type AWSResponse CreateJobQueue

Defined in Amazonka.Batch.CreateJobQueue

type AWSResponse CreateJobQueue = CreateJobQueueResponse

type Rep CreateJobQueue

Defined in Amazonka.Batch.CreateJobQueue

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

newCreateJobQueue

Arguments

:: Text

CreateJobQueue

-> Int

CreateJobQueue

-> CreateJobQueue

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)

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)

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))

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

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

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]

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

See: newCreateJobQueueResponse smart constructor.

Constructors

CreateJobQueueResponse'

Fields

• httpStatus :: Int

  The response's http status code.

• jobQueueName :: Text

  The name of the job queue.

• jobQueueArn :: Text

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

Instances

Generic CreateJobQueueResponse

Defined in Amazonka.Batch.CreateJobQueue

Associated Types

type Rep CreateJobQueueResponse :: Type -> Type

Methods

from :: CreateJobQueueResponse -> Rep CreateJobQueueResponse x

to :: Rep CreateJobQueueResponse x -> CreateJobQueueResponse

Read CreateJobQueueResponse

Defined in Amazonka.Batch.CreateJobQueue

Methods

readsPrec :: Int -> ReadS CreateJobQueueResponse

readList :: ReadS [CreateJobQueueResponse]

readPrec :: ReadPrec CreateJobQueueResponse

readListPrec :: ReadPrec [CreateJobQueueResponse]

Show CreateJobQueueResponse

Defined in Amazonka.Batch.CreateJobQueue

Methods

showsPrec :: Int -> CreateJobQueueResponse -> ShowS

show :: CreateJobQueueResponse -> String

showList :: [CreateJobQueueResponse] -> ShowS

NFData CreateJobQueueResponse

Defined in Amazonka.Batch.CreateJobQueue

Methods

rnf :: CreateJobQueueResponse -> ()

Eq CreateJobQueueResponse

Defined in Amazonka.Batch.CreateJobQueue

Methods

(==) :: CreateJobQueueResponse -> CreateJobQueueResponse -> Bool

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

type Rep CreateJobQueueResponse

Defined in Amazonka.Batch.CreateJobQueue

type Rep CreateJobQueueResponse = D1 ('MetaData "CreateJobQueueResponse" "Amazonka.Batch.CreateJobQueue" "amazonka-batch-2.0-Ey2VZ5obnq65VwmlrJ2r2K" 'False) (C1 ('MetaCons "CreateJobQueueResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: (S1 ('MetaSel ('Just "jobQueueName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "jobQueueArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newCreateJobQueueResponse

Arguments

:: Int

$sel:httpStatus:CreateJobQueueResponse'

-> Text

CreateJobQueue

-> Text

CreateJobQueueResponse

-> 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

The response's http status code.

createJobQueueResponse_jobQueueName :: Lens' CreateJobQueueResponse Text

The name of the job queue.

createJobQueueResponse_jobQueueArn :: Lens' CreateJobQueueResponse Text

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