1. Packages
  2. AWS Native
  3. API Docs
  4. batch
  5. getSchedulingPolicy

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.108.4 published on Tuesday, Jun 18, 2024 by Pulumi

aws-native.batch.getSchedulingPolicy

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.108.4 published on Tuesday, Jun 18, 2024 by Pulumi

    Resource Type schema for AWS::Batch::SchedulingPolicy

    Using getSchedulingPolicy

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getSchedulingPolicy(args: GetSchedulingPolicyArgs, opts?: InvokeOptions): Promise<GetSchedulingPolicyResult>
    function getSchedulingPolicyOutput(args: GetSchedulingPolicyOutputArgs, opts?: InvokeOptions): Output<GetSchedulingPolicyResult>
    def get_scheduling_policy(arn: Optional[str] = None,
                              opts: Optional[InvokeOptions] = None) -> GetSchedulingPolicyResult
    def get_scheduling_policy_output(arn: Optional[pulumi.Input[str]] = None,
                              opts: Optional[InvokeOptions] = None) -> Output[GetSchedulingPolicyResult]
    func LookupSchedulingPolicy(ctx *Context, args *LookupSchedulingPolicyArgs, opts ...InvokeOption) (*LookupSchedulingPolicyResult, error)
    func LookupSchedulingPolicyOutput(ctx *Context, args *LookupSchedulingPolicyOutputArgs, opts ...InvokeOption) LookupSchedulingPolicyResultOutput

    > Note: This function is named LookupSchedulingPolicy in the Go SDK.

    public static class GetSchedulingPolicy 
    {
        public static Task<GetSchedulingPolicyResult> InvokeAsync(GetSchedulingPolicyArgs args, InvokeOptions? opts = null)
        public static Output<GetSchedulingPolicyResult> Invoke(GetSchedulingPolicyInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetSchedulingPolicyResult> getSchedulingPolicy(GetSchedulingPolicyArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: aws-native:batch:getSchedulingPolicy
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Arn string
    Returns the scheduling policy ARN, such as batch: *us-east-1* : *111122223333* :scheduling-policy/ *HighPriority* .
    Arn string
    Returns the scheduling policy ARN, such as batch: *us-east-1* : *111122223333* :scheduling-policy/ *HighPriority* .
    arn String
    Returns the scheduling policy ARN, such as batch: *us-east-1* : *111122223333* :scheduling-policy/ *HighPriority* .
    arn string
    Returns the scheduling policy ARN, such as batch: *us-east-1* : *111122223333* :scheduling-policy/ *HighPriority* .
    arn str
    Returns the scheduling policy ARN, such as batch: *us-east-1* : *111122223333* :scheduling-policy/ *HighPriority* .
    arn String
    Returns the scheduling policy ARN, such as batch: *us-east-1* : *111122223333* :scheduling-policy/ *HighPriority* .

    getSchedulingPolicy Result

    The following output properties are available:

    Arn string
    Returns the scheduling policy ARN, such as batch: *us-east-1* : *111122223333* :scheduling-policy/ *HighPriority* .
    FairsharePolicy Pulumi.AwsNative.Batch.Outputs.SchedulingPolicyFairsharePolicy
    The fair share policy of the scheduling policy.
    Arn string
    Returns the scheduling policy ARN, such as batch: *us-east-1* : *111122223333* :scheduling-policy/ *HighPriority* .
    FairsharePolicy SchedulingPolicyFairsharePolicy
    The fair share policy of the scheduling policy.
    arn String
    Returns the scheduling policy ARN, such as batch: *us-east-1* : *111122223333* :scheduling-policy/ *HighPriority* .
    fairsharePolicy SchedulingPolicyFairsharePolicy
    The fair share policy of the scheduling policy.
    arn string
    Returns the scheduling policy ARN, such as batch: *us-east-1* : *111122223333* :scheduling-policy/ *HighPriority* .
    fairsharePolicy SchedulingPolicyFairsharePolicy
    The fair share policy of the scheduling policy.
    arn str
    Returns the scheduling policy ARN, such as batch: *us-east-1* : *111122223333* :scheduling-policy/ *HighPriority* .
    fairshare_policy SchedulingPolicyFairsharePolicy
    The fair share policy of the scheduling policy.
    arn String
    Returns the scheduling policy ARN, such as batch: *us-east-1* : *111122223333* :scheduling-policy/ *HighPriority* .
    fairsharePolicy Property Map
    The fair share policy of the scheduling policy.

    Supporting Types

    SchedulingPolicyFairsharePolicy

    ComputeReservation double

    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 AWS 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 AWS 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.

    ShareDecaySeconds double
    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 that only current usage is measured. The decay allows for more recently run jobs to have more weight than jobs that ran earlier. The maximum supported value is 604800 (1 week).
    ShareDistribution List<Pulumi.AwsNative.Batch.Inputs.SchedulingPolicyShareAttributes>
    List of Share Attributes
    ComputeReservation float64

    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 AWS 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 AWS 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.

    ShareDecaySeconds float64
    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 that only current usage is measured. The decay allows for more recently run jobs to have more weight than jobs that ran earlier. The maximum supported value is 604800 (1 week).
    ShareDistribution []SchedulingPolicyShareAttributes
    List of Share Attributes
    computeReservation Double

    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 AWS 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 AWS 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.

    shareDecaySeconds Double
    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 that only current usage is measured. The decay allows for more recently run jobs to have more weight than jobs that ran earlier. The maximum supported value is 604800 (1 week).
    shareDistribution List<SchedulingPolicyShareAttributes>
    List of Share Attributes
    computeReservation number

    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 AWS 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 AWS 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.

    shareDecaySeconds number
    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 that only current usage is measured. The decay allows for more recently run jobs to have more weight than jobs that ran earlier. The maximum supported value is 604800 (1 week).
    shareDistribution SchedulingPolicyShareAttributes[]
    List of Share Attributes
    compute_reservation float

    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 AWS 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 AWS 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 float
    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 that only current usage is measured. The decay allows for more recently run jobs to have more weight than jobs that ran earlier. The maximum supported value is 604800 (1 week).
    share_distribution Sequence[SchedulingPolicyShareAttributes]
    List of Share Attributes
    computeReservation Number

    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 AWS 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 AWS 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.

    shareDecaySeconds Number
    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 that only current usage is measured. The decay allows for more recently run jobs to have more weight than jobs that ran earlier. The maximum supported value is 604800 (1 week).
    shareDistribution List<Property Map>
    List of Share Attributes

    SchedulingPolicyShareAttributes

    ShareIdentifier string

    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 (*).

    WeightFactor double

    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.

    ShareIdentifier string

    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 (*).

    WeightFactor float64

    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.

    shareIdentifier String

    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 (*).

    weightFactor Double

    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.

    shareIdentifier string

    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 (*).

    weightFactor number

    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.

    share_identifier str

    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 float

    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.

    shareIdentifier String

    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 (*).

    weightFactor Number

    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.

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.108.4 published on Tuesday, Jun 18, 2024 by Pulumi