Class: Aws::Batch::Types::CapacityLimit

Inherits:

Struct

Object
Struct
Aws::Batch::Types::CapacityLimit

show all

Includes:: Structure

Defined in:: lib/aws-sdk-batch/types.rb

Overview

Defines the capacity limit for a service environment. This structure specifies the maximum amount of resources that can be used by service jobs in the environment.

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#capacity_unit ⇒ String

The unit of measure for the capacity limit.
#max_capacity ⇒ Integer

The maximum capacity available for the service environment.

Instance Attribute Details

#capacity_unit ⇒ `String`

The unit of measure for the capacity limit. This defines how the maxCapacity value should be interpreted. For ‘SAGEMAKER_TRAINING` jobs, use `NUM_INSTANCES`.

Returns:

(String)

# File 'lib/aws-sdk-batch/types.rb', line 280

class CapacityLimit < Struct.new(
  :max_capacity,
  :capacity_unit)
  SENSITIVE = []
  include Aws::Structure
end

#max_capacity ⇒ `Integer`

The maximum capacity available for the service environment. This value represents the maximum amount of resources that can be allocated to service jobs.

For example, ‘maxCapacity=50`, `capacityUnit=NUM_INSTANCES`. This indicates that the maximum number of instances that can be run on this service environment is 50. You could then run 5 SageMaker Training jobs that each use 10 instances. However, if you submit another job that requires 10 instances, it will wait in the queue.