/AWS1/CL_BTCJOBQUEUEDETAIL

An object that represents the details for an Batch job queue.

CONSTRUCTOR

IMPORTING

Required arguments:

iv_jobqueuename TYPE /AWS1/BTCSTRING /AWS1/BTCSTRING

The job queue name.

iv_jobqueuearn TYPE /AWS1/BTCSTRING /AWS1/BTCSTRING

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

iv_state TYPE /AWS1/BTCJQSTATE /AWS1/BTCJQSTATE

Describes the ability of the queue 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_priority TYPE /AWS1/BTCINTEGER /AWS1/BTCINTEGER

The priority of the job queue. Job queue priority determines the order that job queues are evaluated when multiple queues dispatch jobs within a shared compute environment. A higher value for priority indicates a higher priority. Queues are evaluated in cycles, in descending order by priority. For example, a job queue with a priority value of 10 is evaluated before a queue with a priority value of 1. All of the compute environments must be either Amazon EC2 (EC2 or SPOT) or Fargate (FARGATE or FARGATE_SPOT). Amazon EC2 and Fargate compute environments can't be mixed.

Job queue priority doesn't guarantee that a particular job executes before a job in a lower priority queue. Jobs added to higher priority queues during the queue evaluation cycle might not be evaluated until the next cycle. A job is dispatched from a queue only if resources are available when the queue is evaluated. If there are insufficient resources available at that time, the cycle proceeds to the next queue. This means that jobs added to higher priority queues might have to wait for jobs in multiple lower priority queues to complete before they are dispatched. You can use job dependencies to control the order for jobs from queues with different priorities. For more information, see Job Dependencies in the Batch User Guide.

it_computeenvironmentorder TYPE /AWS1/CL_BTCCOMPUTEENVIRONME00=>TT_COMPUTEENVIRONMENTORDERS TT_COMPUTEENVIRONMENTORDERS

The compute environments that are attached to the job queue and the order that job placement is preferred. Compute environments are selected for job placement in ascending order.

Optional arguments:

iv_schedulingpolicyarn TYPE /AWS1/BTCSTRING /AWS1/BTCSTRING

The Amazon Resource Name (ARN) of the scheduling policy. The format is aws:Partition:batch:Region:Account:scheduling-policy/Name . For example, aws:aws:batch:us-west-2:123456789012:scheduling-policy/MySchedulingPolicy.

iv_status TYPE /AWS1/BTCJQSTATUS /AWS1/BTCJQSTATUS

The status of the job queue (for example, CREATING or VALID).

iv_statusreason TYPE /AWS1/BTCSTRING /AWS1/BTCSTRING

A short, human-readable string to provide additional details for the current status of the 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.

iv_jobqueuetype TYPE /AWS1/BTCJOBQUEUETYPE /AWS1/BTCJOBQUEUETYPE

The type of job queue. For service jobs that run on SageMaker Training, this value is SAGEMAKER_TRAINING. For regular container jobs, this value is EKS, ECS, or ECS_FARGATE depending on the compute environment.

it_tags TYPE /AWS1/CL_BTCTAGRISTAGSMAP_W=>TT_TAGRISTAGSMAP TT_TAGRISTAGSMAP

The tags that are applied to the job queue. For more information, see Tagging your Batch resources in Batch User Guide.

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.

---

Queryable Attributes

jobQueueName

The job queue name.

Accessible with the following methods

Method	Description
GET_JOBQUEUENAME()	Getter for JOBQUEUENAME, with configurable default
ASK_JOBQUEUENAME()	Getter for JOBQUEUENAME w/ exceptions if field has no value
HAS_JOBQUEUENAME()	Determine if JOBQUEUENAME has a value

jobQueueArn

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

Accessible with the following methods

Method	Description
GET_JOBQUEUEARN()	Getter for JOBQUEUEARN, with configurable default
ASK_JOBQUEUEARN()	Getter for JOBQUEUEARN w/ exceptions if field has no value
HAS_JOBQUEUEARN()	Determine if JOBQUEUEARN has a value

state

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

Accessible with the following methods

Method	Description
GET_STATE()	Getter for STATE, with configurable default
ASK_STATE()	Getter for STATE w/ exceptions if field has no value
HAS_STATE()	Determine if STATE has a value

schedulingPolicyArn

The Amazon Resource Name (ARN) of the scheduling policy. The format is aws:Partition:batch:Region:Account:scheduling-policy/Name . For example, aws:aws:batch:us-west-2:123456789012:scheduling-policy/MySchedulingPolicy.

Accessible with the following methods

Method	Description
GET_SCHEDULINGPOLICYARN()	Getter for SCHEDULINGPOLICYARN, with configurable default
ASK_SCHEDULINGPOLICYARN()	Getter for SCHEDULINGPOLICYARN w/ exceptions if field has no
HAS_SCHEDULINGPOLICYARN()	Determine if SCHEDULINGPOLICYARN has a value

status

The status of the job queue (for example, CREATING or VALID).

Accessible with the following methods

Method	Description
GET_STATUS()	Getter for STATUS, with configurable default
ASK_STATUS()	Getter for STATUS w/ exceptions if field has no value
HAS_STATUS()	Determine if STATUS has a value

statusReason

A short, human-readable string to provide additional details for the current status of the job queue.

Accessible with the following methods

Method	Description
GET_STATUSREASON()	Getter for STATUSREASON, with configurable default
ASK_STATUSREASON()	Getter for STATUSREASON w/ exceptions if field has no value
HAS_STATUSREASON()	Determine if STATUSREASON has a value

priority

The priority of the job queue. Job queue priority determines the order that job queues are evaluated when multiple queues dispatch jobs within a shared compute environment. A higher value for priority indicates a higher priority. Queues are evaluated in cycles, in descending order by priority. For example, a job queue with a priority value of 10 is evaluated before a queue with a priority value of 1. All of the compute environments must be either Amazon EC2 (EC2 or SPOT) or Fargate (FARGATE or FARGATE_SPOT). Amazon EC2 and Fargate compute environments can't be mixed.

Job queue priority doesn't guarantee that a particular job executes before a job in a lower priority queue. Jobs added to higher priority queues during the queue evaluation cycle might not be evaluated until the next cycle. A job is dispatched from a queue only if resources are available when the queue is evaluated. If there are insufficient resources available at that time, the cycle proceeds to the next queue. This means that jobs added to higher priority queues might have to wait for jobs in multiple lower priority queues to complete before they are dispatched. You can use job dependencies to control the order for jobs from queues with different priorities. For more information, see Job Dependencies in the Batch User Guide.

Accessible with the following methods

Method	Description
GET_PRIORITY()	Getter for PRIORITY, with configurable default
ASK_PRIORITY()	Getter for PRIORITY w/ exceptions if field has no value
HAS_PRIORITY()	Determine if PRIORITY has a value

computeEnvironmentOrder

The compute environments that are attached to the job queue and the order that job placement is preferred. Compute environments are selected for job placement in ascending order.

Accessible with the following methods

Method	Description
GET_COMPUTEENVIRONMENTORDER()	Getter for COMPUTEENVIRONMENTORDER, with configurable defaul
ASK_COMPUTEENVIRONMENTORDER()	Getter for COMPUTEENVIRONMENTORDER w/ exceptions if field ha
HAS_COMPUTEENVIRONMENTORDER()	Determine if COMPUTEENVIRONMENTORDER has a value

serviceEnvironmentOrder

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.

Accessible with the following methods

Method	Description
GET_SERVICEENVIRONMENTORDER()	Getter for SERVICEENVIRONMENTORDER, with configurable defaul
ASK_SERVICEENVIRONMENTORDER()	Getter for SERVICEENVIRONMENTORDER w/ exceptions if field ha
HAS_SERVICEENVIRONMENTORDER()	Determine if SERVICEENVIRONMENTORDER has a value

jobQueueType

The type of job queue. For service jobs that run on SageMaker Training, this value is SAGEMAKER_TRAINING. For regular container jobs, this value is EKS, ECS, or ECS_FARGATE depending on the compute environment.

Accessible with the following methods

Method	Description
GET_JOBQUEUETYPE()	Getter for JOBQUEUETYPE, with configurable default
ASK_JOBQUEUETYPE()	Getter for JOBQUEUETYPE w/ exceptions if field has no value
HAS_JOBQUEUETYPE()	Determine if JOBQUEUETYPE has a value

tags

The tags that are applied to the job queue. For more information, see Tagging your Batch resources in Batch User Guide.

Accessible with the following methods

Method	Description
GET_TAGS()	Getter for TAGS, with configurable default
ASK_TAGS()	Getter for TAGS w/ exceptions if field has no value
HAS_TAGS()	Determine if TAGS has a value

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.

Accessible with the following methods

Method	Description
GET_JOBSTATETIMELIMITACTIONS()	Getter for JOBSTATETIMELIMITACTIONS, with configurable defau
ASK_JOBSTATETIMELIMITACTIONS()	Getter for JOBSTATETIMELIMITACTIONS w/ exceptions if field h
HAS_JOBSTATETIMELIMITACTIONS()	Determine if JOBSTATETIMELIMITACTIONS has a value

Public Local Types In This Class

Internal table types, representing arrays and maps of this class, are defined as local types:

TT_JOBQUEUEDETAILLIST

TYPES TT_JOBQUEUEDETAILLIST TYPE STANDARD TABLE OF REF TO /AWS1/CL_BTCJOBQUEUEDETAIL WITH DEFAULT KEY
.