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

Amazonka.Batch.UpdateJobQueue

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Updates a job queue.

Synopsis

data UpdateJobQueue = UpdateJobQueue' {
- computeEnvironmentOrder :: Maybe [ComputeEnvironmentOrder]
- priority :: Maybe Int
- schedulingPolicyArn :: Maybe Text
- state :: Maybe JQState
- jobQueue :: Text
}
newUpdateJobQueue :: Text -> UpdateJobQueue
updateJobQueue_computeEnvironmentOrder :: Lens' UpdateJobQueue (Maybe [ComputeEnvironmentOrder])
updateJobQueue_priority :: Lens' UpdateJobQueue (Maybe Int)
updateJobQueue_schedulingPolicyArn :: Lens' UpdateJobQueue (Maybe Text)
updateJobQueue_state :: Lens' UpdateJobQueue (Maybe JQState)
updateJobQueue_jobQueue :: Lens' UpdateJobQueue Text
data UpdateJobQueueResponse = UpdateJobQueueResponse' {
- jobQueueArn :: Maybe Text
- jobQueueName :: Maybe Text
- httpStatus :: Int
}
newUpdateJobQueueResponse :: Int -> UpdateJobQueueResponse
updateJobQueueResponse_jobQueueArn :: Lens' UpdateJobQueueResponse (Maybe Text)
updateJobQueueResponse_jobQueueName :: Lens' UpdateJobQueueResponse (Maybe Text)
updateJobQueueResponse_httpStatus :: Lens' UpdateJobQueueResponse Int

Creating a Request

data UpdateJobQueue Source #

Contains the parameters for UpdateJobQueue.

See: newUpdateJobQueue smart constructor.

Constructors

UpdateJobQueue'

Fields

computeEnvironmentOrder :: Maybe [ComputeEnvironmentOrder]
Details the set of compute environments mapped to a job queue and their order relative to each other. This is one of the parameters used by the job scheduler to determine which compute environment runs a given job. Compute environments must be in the VALID state before you can associate them 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.
priority :: Maybe 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.
schedulingPolicyArn :: Maybe Text
Amazon Resource Name (ARN) of the fair share scheduling policy. Once a job queue is created, the fair share scheduling policy can be replaced but not removed. The format is aws:Partition:batch:Region:Account:scheduling-policy/Name . For example, aws:aws:batch:us-west-2:123456789012:scheduling-policy/MySchedulingPolicy.
state :: Maybe JQState
Describes the queue's ability 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.
jobQueue :: Text
The name or the Amazon Resource Name (ARN) of the job queue.

Instances

Instances details

ToJSON UpdateJobQueue Source #
Instance details Defined in Amazonka.Batch.UpdateJobQueue Methods toJSON :: UpdateJobQueue -> Value # toEncoding :: UpdateJobQueue -> Encoding # toJSONList :: [UpdateJobQueue] -> Value # toEncodingList :: [UpdateJobQueue] -> Encoding #
ToHeaders UpdateJobQueue Source #
Instance details Defined in Amazonka.Batch.UpdateJobQueue Methods toHeaders :: UpdateJobQueue -> [Header] #
ToPath UpdateJobQueue Source #
Instance details Defined in Amazonka.Batch.UpdateJobQueue Methods toPath :: UpdateJobQueue -> ByteString #
ToQuery UpdateJobQueue Source #
Instance details Defined in Amazonka.Batch.UpdateJobQueue Methods toQuery :: UpdateJobQueue -> QueryString #
AWSRequest UpdateJobQueue Source #
Instance details Defined in Amazonka.Batch.UpdateJobQueue Associated Types type AWSResponse UpdateJobQueue # Methods request :: (Service -> Service) -> UpdateJobQueue -> Request UpdateJobQueue # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy UpdateJobQueue -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateJobQueue))) #
Generic UpdateJobQueue Source #
Instance details Defined in Amazonka.Batch.UpdateJobQueue Associated Types type Rep UpdateJobQueue :: Type -> Type # Methods from :: UpdateJobQueue -> Rep UpdateJobQueue x # to :: Rep UpdateJobQueue x -> UpdateJobQueue #
Read UpdateJobQueue Source #
Instance details Defined in Amazonka.Batch.UpdateJobQueue Methods readsPrec :: Int -> ReadS UpdateJobQueue # readList :: ReadS [UpdateJobQueue] # readPrec :: ReadPrec UpdateJobQueue # readListPrec :: ReadPrec [UpdateJobQueue] #
Show UpdateJobQueue Source #
Instance details Defined in Amazonka.Batch.UpdateJobQueue Methods showsPrec :: Int -> UpdateJobQueue -> ShowS # show :: UpdateJobQueue -> String # showList :: [UpdateJobQueue] -> ShowS #
NFData UpdateJobQueue Source #
Instance details Defined in Amazonka.Batch.UpdateJobQueue Methods rnf :: UpdateJobQueue -> () #
Eq UpdateJobQueue Source #
Instance details Defined in Amazonka.Batch.UpdateJobQueue Methods (==) :: UpdateJobQueue -> UpdateJobQueue -> Bool # (/=) :: UpdateJobQueue -> UpdateJobQueue -> Bool #
Hashable UpdateJobQueue Source #
Instance details Defined in Amazonka.Batch.UpdateJobQueue Methods hashWithSalt :: Int -> UpdateJobQueue -> Int # hash :: UpdateJobQueue -> Int #
type AWSResponse UpdateJobQueue Source #
Instance details Defined in Amazonka.Batch.UpdateJobQueue type AWSResponse UpdateJobQueue = UpdateJobQueueResponse
type Rep UpdateJobQueue Source #
Instance details Defined in Amazonka.Batch.UpdateJobQueue type Rep UpdateJobQueue = D1 ('MetaData "UpdateJobQueue" "Amazonka.Batch.UpdateJobQueue" "amazonka-batch-2.0-Ey2VZ5obnq65VwmlrJ2r2K" 'False) (C1 ('MetaCons "UpdateJobQueue'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "computeEnvironmentOrder") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ComputeEnvironmentOrder])) :: S1 ('MetaSel ('Just "priority") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))) :: (S1 ('MetaSel ('Just "schedulingPolicyArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "state") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe JQState)) :: S1 ('MetaSel ('Just "jobQueue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newUpdateJobQueue Source #

Arguments

:: Text	`UpdateJobQueue`
-> UpdateJobQueue

Create a value of UpdateJobQueue 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:

UpdateJobQueue, updateJobQueue_computeEnvironmentOrder - Details the set of compute environments mapped to a job queue and their order relative to each other. This is one of the parameters used by the job scheduler to determine which compute environment runs a given job. Compute environments must be in the VALID state before you can associate them 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.

UpdateJobQueue, updateJobQueue_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.

UpdateJobQueue, updateJobQueue_schedulingPolicyArn - Amazon Resource Name (ARN) of the fair share scheduling policy. Once a job queue is created, the fair share scheduling policy can be replaced but not removed. The format is aws:Partition:batch:Region:Account:scheduling-policy/Name . For example, aws:aws:batch:us-west-2:123456789012:scheduling-policy/MySchedulingPolicy.

UpdateJobQueue, updateJobQueue_state - Describes the queue's ability 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.

UpdateJobQueue, updateJobQueue_jobQueue - The name or the Amazon Resource Name (ARN) of the job queue.

Request Lenses

updateJobQueue_computeEnvironmentOrder :: Lens' UpdateJobQueue (Maybe [ComputeEnvironmentOrder]) Source #

Details the set of compute environments mapped to a job queue and their order relative to each other. This is one of the parameters used by the job scheduler to determine which compute environment runs a given job. Compute environments must be in the VALID state before you can associate them 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.

updateJobQueue_priority :: Lens' UpdateJobQueue (Maybe 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.

updateJobQueue_schedulingPolicyArn :: Lens' UpdateJobQueue (Maybe Text) Source #

Amazon Resource Name (ARN) of the fair share scheduling policy. Once a job queue is created, the fair share scheduling policy can be replaced but not removed. The format is aws:Partition:batch:Region:Account:scheduling-policy/Name . For example, aws:aws:batch:us-west-2:123456789012:scheduling-policy/MySchedulingPolicy.

updateJobQueue_state :: Lens' UpdateJobQueue (Maybe JQState) Source #

Describes the queue's ability 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.

updateJobQueue_jobQueue :: Lens' UpdateJobQueue Text Source #

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

Destructuring the Response

data UpdateJobQueueResponse Source #

See: newUpdateJobQueueResponse smart constructor.

Constructors

UpdateJobQueueResponse'
Fields jobQueueArn :: Maybe Text The Amazon Resource Name (ARN) of the job queue. jobQueueName :: Maybe Text The name of the job queue. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic UpdateJobQueueResponse Source #
Instance details Defined in Amazonka.Batch.UpdateJobQueue Associated Types type Rep UpdateJobQueueResponse :: Type -> Type # Methods from :: UpdateJobQueueResponse -> Rep UpdateJobQueueResponse x # to :: Rep UpdateJobQueueResponse x -> UpdateJobQueueResponse #
Read UpdateJobQueueResponse Source #
Instance details Defined in Amazonka.Batch.UpdateJobQueue Methods readsPrec :: Int -> ReadS UpdateJobQueueResponse # readList :: ReadS [UpdateJobQueueResponse] # readPrec :: ReadPrec UpdateJobQueueResponse # readListPrec :: ReadPrec [UpdateJobQueueResponse] #
Show UpdateJobQueueResponse Source #
Instance details Defined in Amazonka.Batch.UpdateJobQueue Methods showsPrec :: Int -> UpdateJobQueueResponse -> ShowS # show :: UpdateJobQueueResponse -> String # showList :: [UpdateJobQueueResponse] -> ShowS #
NFData UpdateJobQueueResponse Source #
Instance details Defined in Amazonka.Batch.UpdateJobQueue Methods rnf :: UpdateJobQueueResponse -> () #
Eq UpdateJobQueueResponse Source #
Instance details Defined in Amazonka.Batch.UpdateJobQueue Methods (==) :: UpdateJobQueueResponse -> UpdateJobQueueResponse -> Bool # (/=) :: UpdateJobQueueResponse -> UpdateJobQueueResponse -> Bool #
type Rep UpdateJobQueueResponse Source #
Instance details Defined in Amazonka.Batch.UpdateJobQueue type Rep UpdateJobQueueResponse = D1 ('MetaData "UpdateJobQueueResponse" "Amazonka.Batch.UpdateJobQueue" "amazonka-batch-2.0-Ey2VZ5obnq65VwmlrJ2r2K" 'False) (C1 ('MetaCons "UpdateJobQueueResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "jobQueueArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "jobQueueName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newUpdateJobQueueResponse Source #

Arguments

:: Int	`$sel:httpStatus:UpdateJobQueueResponse'`
-> UpdateJobQueueResponse

Create a value of UpdateJobQueueResponse 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:

UpdateJobQueueResponse, updateJobQueueResponse_jobQueueArn - The Amazon Resource Name (ARN) of the job queue.

UpdateJobQueueResponse, updateJobQueueResponse_jobQueueName - The name of the job queue.

$sel:httpStatus:UpdateJobQueueResponse', updateJobQueueResponse_httpStatus - The response's http status code.

Response Lenses

updateJobQueueResponse_jobQueueArn :: Lens' UpdateJobQueueResponse (Maybe Text) Source #

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

updateJobQueueResponse_jobQueueName :: Lens' UpdateJobQueueResponse (Maybe Text) Source #

The name of the job queue.

updateJobQueueResponse_httpStatus :: Lens' UpdateJobQueueResponse Int Source #

The response's http status code.