Batch / Client / update_scheduling_policy

update_scheduling_policy#

Batch.Client.update_scheduling_policy(**kwargs)#

Updates a scheduling policy.

See also: AWS API Documentation

Request Syntax

response = client.update_scheduling_policy(
    arn='string',
    fairsharePolicy={
        'shareDecaySeconds': 123,
        'computeReservation': 123,
        'shareDistribution': [
            {
                'shareIdentifier': 'string',
                'weightFactor': ...
            },
        ]
    }
)
Parameters:

  • arn (string) –

    [REQUIRED]

    The Amazon Resource Name (ARN) of the scheduling policy to update.

  • fairsharePolicy (dict) –

    The fair-share policy scheduling details.

    • shareDecaySeconds (integer) –

      The amount of time (in seconds) to use to calculate a fair-share percentage for each 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.

    • computeReservation (integer) –

      A value used to reserve some of the available maximum vCPU for share identifiers that aren’t already used.

      The reserved ratio is (computeReservation/100)^ActiveFairShares where ActiveFairShares is the number of active share identifiers.

      For example, a computeReservation value of 50 indicates that Batch reserves 50% of the maximum available vCPU if there’s only one share identifier. It reserves 25% if there are two share identifiers. It reserves 12.5% if there are three share identifiers. A computeReservation value of 25 indicates that Batch should reserve 25% of the maximum available vCPU if there’s only one share identifier, 6.25% if there are two fair share identifiers, and 1.56% if there are three share identifiers.

      The minimum value is 0 and the maximum value is 99.

    • shareDistribution (list) –

      An array of SharedIdentifier objects that contain the weights for the share identifiers for the fair-share policy. Share identifiers that aren’t included have a default weight of 1.0.

      • (dict) –

        Specifies the weights for the share identifiers for the fair-share policy. Share identifiers that aren’t included have a default weight of 1.0.

        • shareIdentifier (string) – [REQUIRED]

          A share identifier or share identifier prefix. If the string ends with an asterisk (*), this entry specifies the weight factor to use for share identifiers that start with that prefix. The list of 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 share identifiers active in a job queue.

          The string is limited to 255 alphanumeric characters, and can be followed by an asterisk (*).

        • weightFactor (float) –

          The weight factor for the 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.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) –

Exceptions