v1

latestOpenAPI 3.0.12026-07-26152262362.2 KB
PS4Commitments AWS

List payer account engine settings

Returns automation and recommendation engine settings for every onboarded payer account, broken down by product line (compute, database). Settings are configured at the customer level and apply uniformly across all payer accounts. Only product lines that are activated/onboarded for a given payer account are returned. The purchaseAccountId is the linked AWS account designated to execute SP purchases on behalf of that payer account.

get/ps4commitments/v1/aws/settings

Query parameters

pageTokenstring

Opaque cursor token returned by a previous list response. Omit to start from the beginning; an empty or absent token in a response means there are no more results. Do not parse it. A structurally invalid cursor returns 400 with code pagination_token_invalid; an expired cursor returns 400 with code pagination_token_expired — restart pagination from the beginning.

maxResultsinteger

Maximum number of items to return. Server may return fewer. Defaults to 50; maximum 500.

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

List of per-payer-account per-product-line engine settings.

pageTokenstring nullable

Opaque cursor for the next page. Absent when this is the last page.

rowCountinteger

Number of items returned in this page.

Example response

{
  "items": [
    {
      "payerAccountId": "123456789012",
      "purchaseAccountId": "987654321098"
    }
  ]
}