aws_batch_scheduling_policy
account_id
Type: STRING
arn
Type: STRING
Provider name: arn
Description: The Amazon Resource Name (ARN) of the scheduling policy. An example is arn:aws:batch:us-east-1:123456789012:scheduling-policy/HighPriority
.
fairshare_policy
Type: STRUCT
Provider name: fairsharePolicy
Description: The fair share policy for the scheduling policy.
compute_reservation
Type: INT32
Provider name: computeReservation
Description: A value used to reserve some of the available maximum vCPU for fair share identifiers that aren’t already used. The reserved ratio is (computeReservation/100)^ActiveFairShares
where ActiveFairShares
is the number of active fair share identifiers. For example, a computeReservation
value of 50 indicates that Batch reserves 50% of the maximum available vCPU if there’s only one fair share identifier. It reserves 25% if there are two fair share identifiers. It reserves 12.5% if there are three fair share identifiers. A computeReservation
value of 25 indicates that Batch should reserve 25% of the maximum available vCPU if there’s only one fair share identifier, 6.25% if there are two fair share identifiers, and 1.56% if there are three fair share identifiers. The minimum value is 0 and the maximum value is 99.
share_decay_seconds
Type: INT32
Provider name: shareDecaySeconds
Description: The amount of time (in seconds) to use to calculate a fair share percentage for each fair share identifier in use. A value of zero (0) indicates the default minimum time window (600 seconds). The maximum supported value is 604800 (1 week). The decay allows for more recently run jobs to have more weight than jobs that ran earlier. Consider adjusting this number if you have jobs that (on average) run longer than ten minutes, or a large difference in job count or job run times between share identifiers, and the allocation of resources doesn’t meet your needs.
share_distribution
Type: UNORDERED_LIST_STRUCT
Provider name: shareDistribution
Description: An array of SharedIdentifier
objects that contain the weights for the fair share identifiers for the fair share policy. Fair share identifiers that aren’t included have a default weight of 1.0
.
share_identifier
Type: STRING
Provider name: shareIdentifier
Description: A fair share identifier or fair share identifier prefix. If the string ends with an asterisk (), this entry specifies the weight factor to use for fair share identifiers that start with that prefix. The list of fair share identifiers in a fair share policy can’t overlap. For example, you can’t have one that specifies a shareIdentifier
of UserA
and another that specifies a shareIdentifier
of UserA-1
. There can be no more than 500 fair share identifiers active in a job queue. The string is limited to 255 alphanumeric characters, and can be followed by an asterisk (*).
weight_factor
Type: FLOAT
Provider name: weightFactor
Description: The weight factor for the fair share identifier. The default value is 1.0. A lower value has a higher priority for compute resources. For example, jobs that use a share identifier with a weight factor of 0.125 (1/8) get 8 times the compute resources of jobs that use a share identifier with a weight factor of 1. The smallest supported value is 0.0001, and the largest supported value is 999.9999.
name
Type: STRING
Provider name: name
Description: The name of the scheduling policy.
Type: UNORDERED_LIST_STRING