Network.AWS.Batch.CreateJobQueue

Creates an AWS 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 in which the AWS 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

createJobQueue

Arguments

:: Text

cjqJobQueueName

-> Int

cjqPriority

-> CreateJobQueue

Creates a value of CreateJobQueue with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• cjqState - The state of the job queue. If the job queue state is ENABLED , it is able to accept jobs.
• cjqJobQueueName - The name of the job queue.
• cjqPriority - 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 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 .
• cjqComputeEnvironmentOrder - 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 should execute a given job. Compute environments must be in the VALID state before you can associate them with a job queue. You can associate up to 3 compute environments with a job queue.

data CreateJobQueue

See: createJobQueue smart constructor.

Instances

Eq CreateJobQueue

Methods

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

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

Data CreateJobQueue

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CreateJobQueue -> c CreateJobQueue

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CreateJobQueue

toConstr :: CreateJobQueue -> Constr

dataTypeOf :: CreateJobQueue -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c CreateJobQueue)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CreateJobQueue)

gmapT :: (forall b. Data b => b -> b) -> CreateJobQueue -> CreateJobQueue

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CreateJobQueue -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CreateJobQueue -> r

gmapQ :: (forall d. Data d => d -> u) -> CreateJobQueue -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> CreateJobQueue -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> CreateJobQueue -> m CreateJobQueue

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateJobQueue -> m CreateJobQueue

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateJobQueue -> m CreateJobQueue

Read CreateJobQueue

Methods

readsPrec :: Int -> ReadS CreateJobQueue

readList :: ReadS [CreateJobQueue]

readPrec :: ReadPrec CreateJobQueue

readListPrec :: ReadPrec [CreateJobQueue]

Show CreateJobQueue

Methods

showsPrec :: Int -> CreateJobQueue -> ShowS

show :: CreateJobQueue -> String

showList :: [CreateJobQueue] -> ShowS

Generic CreateJobQueue

Associated Types

type Rep CreateJobQueue :: * -> *

Methods

from :: CreateJobQueue -> Rep CreateJobQueue x

to :: Rep CreateJobQueue x -> CreateJobQueue

Hashable CreateJobQueue

Methods

hashWithSalt :: Int -> CreateJobQueue -> Int

hash :: CreateJobQueue -> Int

ToJSON CreateJobQueue

Methods

toJSON :: CreateJobQueue -> Value

toEncoding :: CreateJobQueue -> Encoding

toJSONList :: [CreateJobQueue] -> Value

toEncodingList :: [CreateJobQueue] -> Encoding

NFData CreateJobQueue

Methods

rnf :: CreateJobQueue -> ()

AWSRequest CreateJobQueue

Associated Types

type Rs CreateJobQueue :: *

Methods

request :: CreateJobQueue -> Request CreateJobQueue

response :: MonadResource m => Logger -> Service -> Proxy * CreateJobQueue -> ClientResponse -> m (Response CreateJobQueue)

ToQuery CreateJobQueue

Methods

toQuery :: CreateJobQueue -> QueryString

ToPath CreateJobQueue

Methods

toPath :: CreateJobQueue -> ByteString

ToHeaders CreateJobQueue

Methods

toHeaders :: CreateJobQueue -> [Header]

type Rep CreateJobQueue

type Rep CreateJobQueue = D1 (MetaData "CreateJobQueue" "Network.AWS.Batch.CreateJobQueue" "amazonka-batch-1.5.0-AMIOP3EprNVIEIQfz4kyfD" False) (C1 (MetaCons "CreateJobQueue'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_cjqState") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe JQState))) (S1 (MetaSel (Just Symbol "_cjqJobQueueName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))) ((:*:) (S1 (MetaSel (Just Symbol "_cjqPriority") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int)) (S1 (MetaSel (Just Symbol "_cjqComputeEnvironmentOrder") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 [ComputeEnvironmentOrder])))))

type Rs CreateJobQueue

type Rs CreateJobQueue = CreateJobQueueResponse

Request Lenses

cjqState :: Lens' CreateJobQueue (Maybe JQState)

The state of the job queue. If the job queue state is ENABLED , it is able to accept jobs.

cjqJobQueueName :: Lens' CreateJobQueue Text

The name of the job queue.

cjqPriority :: 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 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 .

cjqComputeEnvironmentOrder :: 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 should execute a given job. Compute environments must be in the VALID state before you can associate them with a job queue. You can associate up to 3 compute environments with a job queue.

Destructuring the Response

createJobQueueResponse

Arguments

:: Int

cjqrsResponseStatus

-> Text

cjqrsJobQueueName

-> Text

cjqrsJobQueueARN

-> CreateJobQueueResponse

Creates a value of CreateJobQueueResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• cjqrsResponseStatus - -- | The response status code.
• cjqrsJobQueueName - The name of the job queue.
• cjqrsJobQueueARN - The Amazon Resource Name (ARN) of the job queue.

data CreateJobQueueResponse

See: createJobQueueResponse smart constructor.

Instances

Eq CreateJobQueueResponse

Methods

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

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

Data CreateJobQueueResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CreateJobQueueResponse -> c CreateJobQueueResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CreateJobQueueResponse

toConstr :: CreateJobQueueResponse -> Constr

dataTypeOf :: CreateJobQueueResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c CreateJobQueueResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CreateJobQueueResponse)

gmapT :: (forall b. Data b => b -> b) -> CreateJobQueueResponse -> CreateJobQueueResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CreateJobQueueResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CreateJobQueueResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> CreateJobQueueResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> CreateJobQueueResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> CreateJobQueueResponse -> m CreateJobQueueResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateJobQueueResponse -> m CreateJobQueueResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateJobQueueResponse -> m CreateJobQueueResponse

Read CreateJobQueueResponse

Methods

readsPrec :: Int -> ReadS CreateJobQueueResponse

readList :: ReadS [CreateJobQueueResponse]

readPrec :: ReadPrec CreateJobQueueResponse

readListPrec :: ReadPrec [CreateJobQueueResponse]

Show CreateJobQueueResponse

Methods

showsPrec :: Int -> CreateJobQueueResponse -> ShowS

show :: CreateJobQueueResponse -> String

showList :: [CreateJobQueueResponse] -> ShowS

Generic CreateJobQueueResponse

Associated Types

type Rep CreateJobQueueResponse :: * -> *

Methods

from :: CreateJobQueueResponse -> Rep CreateJobQueueResponse x

to :: Rep CreateJobQueueResponse x -> CreateJobQueueResponse

NFData CreateJobQueueResponse

Methods

rnf :: CreateJobQueueResponse -> ()

type Rep CreateJobQueueResponse

type Rep CreateJobQueueResponse = D1 (MetaData "CreateJobQueueResponse" "Network.AWS.Batch.CreateJobQueue" "amazonka-batch-1.5.0-AMIOP3EprNVIEIQfz4kyfD" False) (C1 (MetaCons "CreateJobQueueResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_cjqrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int)) ((:*:) (S1 (MetaSel (Just Symbol "_cjqrsJobQueueName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_cjqrsJobQueueARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))))

Response Lenses

cjqrsResponseStatus :: Lens' CreateJobQueueResponse Int

• - | The response status code.

cjqrsJobQueueName :: Lens' CreateJobQueueResponse Text

The name of the job queue.

cjqrsJobQueueARN :: Lens' CreateJobQueueResponse Text

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