ProductionVariantCapacityReservationSummary
Details about an ML capacity reservation.
Contents
- AvailableInstanceCount
-
The number of instances that are currently available in the ML capacity reservation.
Type: Integer
Valid Range: Minimum value of 0.
Required: No
- CapacityReservationPreference
-
The option that you chose for the capacity reservation. SageMaker AI supports the following options:
- capacity-reservations-only
-
SageMaker AI launches instances only into an ML capacity reservation. If no capacity is available, the instances fail to launch.
Type: String
Valid Values:
capacity-reservations-onlyRequired: No
- Ec2CapacityReservations
-
The EC2 capacity reservations that are shared to this ML capacity reservation, if any.
Type: Array of Ec2CapacityReservation objects
Required: No
- MlReservationArn
-
The Amazon Resource Name (ARN) that uniquely identifies the ML capacity reservation that SageMaker AI applies when it deploys the endpoint.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 258.
Pattern:
arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:ml-reservation/.*Required: No
- TotalInstanceCount
-
The number of instances that you allocated to the ML capacity reservation.
Type: Integer
Valid Range: Minimum value of 0.
Required: No
- UsedByCurrentEndpoint
-
The number of instances from the ML capacity reservation that are being used by the endpoint.
Type: Integer
Valid Range: Minimum value of 0.
Required: No
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: