DescribeReservedCapacity
Retrieves details about a reserved capacity.
Request Syntax
{
"ReservedCapacityArn": "string"
}Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- ReservedCapacityArn
-
ARN of the reserved capacity to describe.
Type: String
Length Constraints: Minimum length of 50. Maximum length of 2048.
Pattern:
arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:reserved-capacity/.*Required: Yes
Response Syntax
{
"AvailabilityZone": "string",
"AvailableInstanceCount": number,
"DurationHours": number,
"DurationMinutes": number,
"EndTime": number,
"InstanceType": "string",
"InUseInstanceCount": number,
"ReservedCapacityArn": "string",
"ReservedCapacityType": "string",
"StartTime": number,
"Status": "string",
"TotalInstanceCount": number,
"UltraServerSummary": {
"AvailableSpareInstanceCount": number,
"InstanceType": "string",
"UltraServerCount": number,
"UltraServerType": "string",
"UnhealthyInstanceCount": number
}
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- AvailabilityZone
-
The Availability Zone where the reserved capacity is provisioned.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 32.
Pattern:
[a-z]+\-[0-9a-z\-]+ - AvailableInstanceCount
-
The number of instances currently available for use in this reserved capacity.
Type: Integer
Valid Range: Minimum value of 0.
- DurationHours
-
The total duration of the reserved capacity in hours.
Type: Long
Valid Range: Minimum value of 0. Maximum value of 87600.
- DurationMinutes
-
The number of minutes for the duration of the reserved capacity. For example, if a reserved capacity starts at 08:55 and ends at 11:30, the minutes field would be 35.
Type: Long
Valid Range: Minimum value of 0. Maximum value of 59.
- EndTime
-
The timestamp when the reserved capacity expires.
Type: Timestamp
- InstanceType
-
The Amazon EC2 instance type used in the reserved capacity.
Type: String
Valid Values:
ml.p4d.24xlarge | ml.p5.48xlarge | ml.p5e.48xlarge | ml.p5en.48xlarge | ml.trn1.32xlarge | ml.trn2.48xlarge | ml.p6-b200.48xlarge | ml.p4de.24xlarge | ml.p6e-gb200.36xlarge - InUseInstanceCount
-
The number of instances currently in use from this reserved capacity.
Type: Integer
Valid Range: Minimum value of 0.
- ReservedCapacityArn
-
ARN of the reserved capacity.
Type: String
Length Constraints: Minimum length of 50. Maximum length of 2048.
Pattern:
arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:reserved-capacity/.* - ReservedCapacityType
-
The type of reserved capacity.
Type: String
Valid Values:
UltraServer | Instance - StartTime
-
The timestamp when the reserved capacity becomes active.
Type: Timestamp
- Status
-
The current status of the reserved capacity.
Type: String
Valid Values:
Pending | Active | Scheduled | Expired | Failed - TotalInstanceCount
-
The total number of instances allocated to this reserved capacity.
Type: Integer
Valid Range: Minimum value of 0.
- UltraServerSummary
-
A summary of the UltraServer associated with this reserved capacity.
Type: UltraServerSummary object
Errors
For information about the errors that are common to all actions, see Common Errors.
- ResourceNotFound
-
Resource being access is not found.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
