Reference
What one Savings Plan commitment would have done
Replays a commitment in dollars an hour over the payer's recent daily bill: the eligible on-demand spend it would have covered, the commitment it would have left unused, its utilization, coverage and monthly savings, day by day, beside the sized profiles and AWS's own figure. A day averages its hours, so every figure is an upper bound on the hourly truth. Free to every organization; never calls AWS. A Database plan is sold for 12 months No Upfront only. payer_account_id may be omitted when the organization has one payer. Missing data answers 200 with unavailable_reason.
Authorization
BearerAuth In: header
Query Parameters
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/api/v1/commitments/purchase-simulation?plan_type=compute&commitment_hourly=1"{
"success": true,
"timestamp": "2019-08-24T14:15:22Z",
"data": {
"grain": "daily",
"source": "cur",
"basis": "public_on_demand",
"currency": "USD",
"payer_account_id": "string",
"plan_type": "compute",
"term_months": 0,
"payment_option": "all_upfront",
"unavailable_reason": "schema_pending",
"window": {
"first_day": "2019-08-24",
"last_day": "2019-08-24",
"days": 0,
"missing_days": 0,
"last_loaded": "2019-08-24"
},
"caveats": [
"string"
],
"profiles": {
"conservative": {
"commitment_hourly": 0,
"uncapped_hourly": 0,
"percentile": 0,
"capped_by": [
"string"
],
"utilization_pct": 0,
"coverage_pct": 0,
"net_savings_monthly": 0,
"net_savings_monthly_at_your_rates": 0
},
"balanced": {
"commitment_hourly": 0,
"uncapped_hourly": 0,
"percentile": 0,
"capped_by": [
"string"
],
"utilization_pct": 0,
"coverage_pct": 0,
"net_savings_monthly": 0,
"net_savings_monthly_at_your_rates": 0
},
"max_savings": {
"commitment_hourly": 0,
"uncapped_hourly": 0,
"percentile": 0,
"capped_by": [
"string"
],
"utilization_pct": 0,
"coverage_pct": 0,
"net_savings_monthly": 0,
"net_savings_monthly_at_your_rates": 0
}
},
"profiles_inverted": false,
"guards": [
{
"name": "string",
"limit": 0,
"applied": true,
"basis": "string"
}
],
"aws": {
"hourly_commitment_to_purchase": 0,
"cap": 0,
"cap_basis": "direct",
"cap_applied": true,
"lookback_days": 0,
"fetched_on": "2019-08-24",
"generated_at": "2019-08-24T14:15:22Z",
"min_hourly_on_demand": 0,
"avg_hourly_on_demand": 0,
"estimated_utilization_pct": 0,
"estimated_monthly_savings": 0,
"basis_check_pct": 0,
"basis_check_flagged": true,
"gap": [
{
"code": "ledger_claims",
"commitment_hourly": 0
}
]
},
"ledger": [
{
"source": "queued_plan",
"reference": "string",
"commitment_hourly": 0,
"on_demand_hourly": 0,
"scope": {
"family": "string",
"region": "string"
},
"effective_from": "2019-08-24"
}
],
"ledger_hourly": 0,
"stale_claims": [
{
"reference": "string",
"commitment_hourly": 0,
"on_demand_hourly": 0,
"accepted_days_ago": 0
}
],
"unmapped_holders": [
"string"
],
"window_changes": [
{
"reference": "string",
"kind": "string",
"change": "started",
"day": "2019-08-24"
}
],
"excluded": [
{
"reason": "string",
"on_demand_daily": 0
}
],
"candidate": {
"commitment_hourly": 0
},
"totals": {
"eligible_on_demand": 0,
"covered_on_demand": 0,
"uncovered_on_demand": 0,
"commitment_cost": 0,
"used_commitment": 0,
"wasted_commitment": 0,
"utilization_pct": 0,
"coverage_pct": 0,
"net_savings_monthly": 0,
"net_savings_monthly_at_your_rates": 0
},
"series": [
{
"day": "2019-08-24",
"eligible_on_demand": 0,
"covered_on_demand": 0,
"uncovered_on_demand": 0,
"used_commitment": 0,
"wasted_commitment": 0,
"commitment_equivalent_hourly": 0
}
],
"curve": [
{
"commitment_hourly": 0,
"net_savings_monthly": 0,
"utilization_pct": 0
}
]
}
}{
"success": false,
"error": {
"code": "string",
"message": "string",
"details": null
},
"timestamp": "2019-08-24T14:15:22Z"
}{
"success": false,
"error": {
"code": "string",
"message": "string",
"details": null
},
"timestamp": "2019-08-24T14:15:22Z"
}{
"success": false,
"error": {
"code": "string",
"message": "string",
"details": null
},
"timestamp": "2019-08-24T14:15:22Z"
}{
"success": false,
"error": {
"code": "string",
"message": "string",
"details": null
},
"timestamp": "2019-08-24T14:15:22Z"
}{
"success": false,
"error": {
"code": "string",
"message": "string",
"details": null
},
"timestamp": "2019-08-24T14:15:22Z"
}{
"success": false,
"error": {
"code": "string",
"message": "string",
"details": null
},
"timestamp": "2019-08-24T14:15:22Z"
}{
"success": false,
"error": {
"code": "string",
"message": "string",
"details": null
},
"timestamp": "2019-08-24T14:15:22Z"
}{
"success": false,
"error": {
"code": "string",
"message": "string",
"details": null
},
"timestamp": "2019-08-24T14:15:22Z"
}Savings Plans and Reserved Instances to buy, sized on the daily bill GET
The uncovered base, as /uncovered returns it, beside one proposal per payer and plan type at 12 months No Upfront. Each proposal offers three profiles sized on the daily CUR floor, net of the commitment already bought or agreed, capped by AWS's own recommendation, and replayed over the last 60 complete days. Free to every organization; reads cached rates and offerings and never calls AWS. raised is null until a proposal can be raised as a purchase. schedule lists every tranche of each purchase schedule with a month still to come: its day, its size, where it stands and why it last shrank or was skipped. reservations lists the new Reserved Instances LevelFour would buy for on-demand usage no Savings Plan covers, each sized on the 10th percentile day, quoted on the cached offering at the guardrails' term, and flagged quota_blocked when the RDS reserved instance quota cannot hold it.
Get commitment recommendations GET
Next Page