Skip to content

/AWS1/IF_BTC=>UPDATEJOBQUEUE()

About UpdateJobQueue

Updates a job queue.

Method Signature

METHODS /AWS1/IF_BTC~UPDATEJOBQUEUE
  IMPORTING
    !IV_JOBQUEUE TYPE /AWS1/BTCSTRING OPTIONAL
    !IV_STATE TYPE /AWS1/BTCJQSTATE OPTIONAL
    !IV_SCHEDULINGPOLICYARN TYPE /AWS1/BTCSTRING OPTIONAL
    !IV_PRIORITY TYPE /AWS1/BTCINTEGER OPTIONAL
    !IT_COMPUTEENVIRONMENTORDER TYPE /AWS1/CL_BTCCOMPUTEENVIRONME00=>TT_COMPUTEENVIRONMENTORDERS OPTIONAL
    !IT_SERVICEENVIRONMENTORDER TYPE /AWS1/CL_BTCSERVICEENVORDER=>TT_SERVICEENVIRONMENTORDERS OPTIONAL
    !IT_JOBSTATETIMELIMITACTIONS TYPE /AWS1/CL_BTCJOBSTATETIMELMTACT=>TT_JOBSTATETIMELIMITACTIONS OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_btcupdatejobqueuersp
  RAISING
    /AWS1/CX_BTCCLIENTEXCEPTION
    /AWS1/CX_BTCSERVEREXCEPTION
    /AWS1/CX_BTCCLIENTEXC
    /AWS1/CX_BTCSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_jobqueue TYPE /AWS1/BTCSTRING /AWS1/BTCSTRING

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

Optional arguments:

iv_state TYPE /AWS1/BTCJQSTATE /AWS1/BTCJQSTATE

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.

iv_schedulingpolicyarn TYPE /AWS1/BTCSTRING /AWS1/BTCSTRING

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.

iv_priority TYPE /AWS1/BTCINTEGER /AWS1/BTCINTEGER

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.

it_computeenvironmentorder TYPE /AWS1/CL_BTCCOMPUTEENVIRONME00=>TT_COMPUTEENVIRONMENTORDERS TT_COMPUTEENVIRONMENTORDERS

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.

it_serviceenvironmentorder TYPE /AWS1/CL_BTCSERVICEENVORDER=>TT_SERVICEENVIRONMENTORDERS TT_SERVICEENVIRONMENTORDERS

The order of the service environment associated with the job queue. Job queues with a higher priority are evaluated first when associated with the same service environment.

it_jobstatetimelimitactions TYPE /AWS1/CL_BTCJOBSTATETIMELMTACT=>TT_JOBSTATETIMELIMITACTIONS TT_JOBSTATETIMELIMITACTIONS

The set of actions that Batch perform on jobs that remain at the head of the job queue in the specified state longer than specified times. Batch will perform each action after maxTimeSeconds has passed. (Note: The minimum value for maxTimeSeconds is 600 (10 minutes) and its maximum value is 86,400 (24 hours).)

RETURNING

oo_output TYPE REF TO /aws1/cl_btcupdatejobqueuersp /AWS1/CL_BTCUPDATEJOBQUEUERSP

Domain /AWS1/RT_ACCOUNT_ID
Primitive Type NUMC

Examples

Syntax Example

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

DATA(lo_result) = lo_client->updatejobqueue(
  it_computeenvironmentorder = VALUE /aws1/cl_btccomputeenvironme00=>tt_computeenvironmentorders(
    (
      new /aws1/cl_btccomputeenvironme00(
        iv_computeenvironment = |string|
        iv_order = 123
      )
    )
  )
  it_jobstatetimelimitactions = VALUE /aws1/cl_btcjobstatetimelmtact=>tt_jobstatetimelimitactions(
    (
      new /aws1/cl_btcjobstatetimelmtact(
        iv_action = |string|
        iv_maxtimeseconds = 123
        iv_reason = |string|
        iv_state = |string|
      )
    )
  )
  it_serviceenvironmentorder = VALUE /aws1/cl_btcserviceenvorder=>tt_serviceenvironmentorders(
    (
      new /aws1/cl_btcserviceenvorder(
        iv_order = 123
        iv_serviceenvironment = |string|
      )
    )
  )
  iv_jobqueue = |string|
  iv_priority = 123
  iv_schedulingpolicyarn = |string|
  iv_state = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_string = lo_result->get_jobqueuename( ).
  lv_string = lo_result->get_jobqueuearn( ).
ENDIF.

To update a job queue

This example disables a job queue so that it can be deleted.

DATA(lo_result) = lo_client->updatejobqueue(
  iv_jobqueue = |GPGPU|
  iv_state = |DISABLED|
).