v1

latestOpenAPI 3.0.12026-07-26152262362.2 KB
PS4Commitments AWS

Get an AWS recommendation

Returns full detail for a single recommendation including analysis metrics.

get/ps4commitments/v1/aws/payer-accounts/{payerAccountId}/recommendations/{serviceId}

Path parameters

payerAccountIdstring required
Example:123456789012

AWS Master Payer Account ID (12-digit AWS account number) that scopes the request.

serviceId'compute' | 'database' required

Service ID (compute|database).

Query parameters

granularity'hour' | 'day' | 'week' | 'month'

Time bucket for eligible spend data points.

Headers

X-Tenant-Idstring
Example:Kp2mN8qL4vR0sT1wX3yZ

Tenant (customer) identifier that conveys the tenant scope for the request (DoiT API Design Standards §15).

Resolution when the header is absent:

  • A key scoped to exactly one tenant resolves to that tenant automatically; the header is optional.
  • A principal that can access more than one tenant (e.g. DoiT-employee keys) must supply the header. Without it the request is rejected with 400 and code tenant_id_required — the server does not guess across tenant scopes.

When the header is present but conflicts with the tenant the key is scoped to, the request is rejected with 400 and code tenant_id_mismatch.

Response

Recommendation detail.