reserved_capacities
Creates, updates, deletes, gets or lists a reserved_capacities resource.
Overview
| Name | reserved_capacities |
| Type | Resource |
| Id | aws.sagemaker.reserved_capacities |
Fields
The following fields are returned by SELECT queries:
- describe_reserved_capacity
| Name | Datatype | Description |
|---|---|---|
availability_zone | string | The Availability Zone where the reserved capacity is provisioned. (pattern: <code>[a-z]+-[0-9a-z-]+</code>) |
available_instance_count | integer | The number of instances currently available for use in this reserved capacity. |
duration_hours | integer (int64) | The total duration of the reserved capacity in hours. |
duration_minutes | integer (int64) | 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. |
end_time | string (date-time) | The timestamp when the reserved capacity expires. |
in_use_instance_count | integer | The number of instances currently in use from this reserved capacity. |
instance_type | string | The Amazon EC2 instance type used in the reserved capacity. (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, ml.p5.4xlarge, ml.p6-b300.48xlarge) |
reserved_capacity_arn | string | ARN of the reserved capacity. (pattern: <code>arn:aws[a-z-]:sagemaker:[a-z0-9-]:[0-9]{12}:reserved-capacity/.*</code>) |
reserved_capacity_type | string | The type of reserved capacity. (UltraServer, Instance) |
start_time | string (date-time) | The timestamp when the reserved capacity becomes active. |
status | string | The current status of the reserved capacity. (Pending, Active, Scheduled, Expired, Failed) |
total_instance_count | integer | The total number of instances allocated to this reserved capacity. |
ultra_server_summary | object | A summary of the UltraServer associated with this reserved capacity. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
describe_reserved_capacity | select | region | Retrieves details about a reserved capacity. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
region | string | AWS region (default: us-east-1) |
SELECT examples
- describe_reserved_capacity
Retrieves details about a reserved capacity.
SELECT
availability_zone,
available_instance_count,
duration_hours,
duration_minutes,
end_time,
in_use_instance_count,
instance_type,
reserved_capacity_arn,
reserved_capacity_type,
start_time,
status,
total_instance_count,
ultra_server_summary
FROM aws.sagemaker.reserved_capacities
WHERE region = '{{ region }}' -- required
;