list-aws-organizations-settings
dci list-aws-organizations-settings [flags]
Returns one item per onboarded AWS organization. Each item includes that AWS organization's commitments purchasing account (purchaseAccountId) and commitment settings for each commitment type activated on that AWS organization (compute, database).
Commitment settings cover recommendation and automation preferences (policy, term, payment option, automation mode, commitment limits, and related fields). They are stored at the customer level per commitment type and therefore have the same values on every AWS organization item. Only purchaseAccountId and which commitment types appear differ per AWS organization.
In the DoiT Console, commitment settings are edited on an account's Settings tab but apply across all AWS organizations for that commitment type; the purchasing account is set per AWS organization on Accounts Settings.
Commitment settings (policy, term, payment option, automation mode, limits) are stored
per customer and commitment type, so they repeat identically on every organization item;
only purchaseAccountId and which commitment types appear differ per organization.
Examples
# The commitments purchasing account and per-commitment-type settings for each onboarded AWS organization.
dci list-aws-organizations-settings
# The nested settings as JSON, for scripts.
dci list-aws-organizations-settings --output json
# Every page as YAML, easier to read when there are many organizations.
dci list-aws-organizations-settings --all --output yaml
Flags
| Flag | Type | Default | Example | Description |
|---|---|---|---|---|
--page-token | string | 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. | ||
--max-results | integer | 50 | Maximum number of items to return. Server may return fewer. Defaults to 50; maximum 500. |
Every command also accepts the CLI-wide flags for output shaping — see Output formats and Table output options.
Output
Settings payload for one onboarded AWS organization, with that AWS organization's purchasing account (purchaseAccountId) and customer-level commitment settings for each activated commitment type (services[].settings).
By default dci renders the result as a table. Use --output json to get the full structure described below — see Output formats.
| Field | Type | Description |
|---|---|---|
items | array of object | |
items[].managementAccountId | string | 12-digit account number of the AWS organization's management (payer) account. |
items[].purchaseAccountId | string | AWS account used for commitment purchases for this AWS organization. Often a member account under the AWS organization, but it may also be the management (payer) account itself. Null if not configured. |
items[].services | array of object | Commitment settings for each commitment type activated on this AWS organization. Settings values are customer-level per commitment type. |
items[].services[].service | string | Commitment type these settings apply to. One of: "compute", "database". |
items[].services[].settings | object | Commitment settings for this commitment type. |
items[].services[].settings.purchaseMode | string | Whether purchases execute automatically or require customer approval before the planner proceeds. Configured in the DoiT Console Settings tab; this settings API is read-only. One of: "autonomous", "requires_approval". |
items[].services[].settings.minimumCommitment | number (double) | Minimum hourly commitment amount (USD) per purchase step. |
items[].services[].settings.lastDayOfMonthForPurchase | integer | Latest calendar day of the month (1–28) on which new purchases may be scheduled. After this day, the No Purchase Window applies until the next month. Default is 25; the maximum allowed value is 28 to leave a buffer before month-end billing cycles. Default: 25. |
items[].services[].settings.maximumCommitment | number (double) | Maximum total hourly commitment (USD). 0 means no cap. Always present on settings responses. |
items[].services[].settings.term | string | Preferred commitment term length for new purchases. |
items[].services[].settings.paymentOption | string | Preferred payment structure for new commitments. |
items[].services[].settings.policy | string | Coverage target policy for recommendations and purchases. |
items[].services[].settings.upfrontPercentage | number (double) | Fraction of total cost paid upfront (0–1) when paymentOption is partial_upfront. In the DoiT Console this is set as 50–99% and applies to AWS Compute only; Database uses no_upfront only. |
pageToken | string | Opaque cursor for the next page. Absent when this is the last page. |
rowCount | integer (int64) | Number of items returned in this page. |
Raw JSON schema
{
"type": "object",
"required": [
"items"
],
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"required": [
"managementAccountId",
"purchaseAccountId",
"services"
],
"properties": {
"managementAccountId": {
"type": "string",
"description": "12-digit account number of the AWS organization's management (payer) account.",
"example": "123456789012"
},
"purchaseAccountId": {
"type": "string",
"description": "AWS account used for commitment purchases for this AWS organization. Often a member account under the AWS organization, but it may also be the management (payer) account itself. Null if not configured.",
"nullable": true,
"example": "987654321098"
},
"services": {
"type": "array",
"items": {
"type": "object",
"required": [
"service",
"settings"
],
"properties": {
"service": {
"type": "string",
"enum": [
"compute",
"database"
],
"description": "Commitment type these settings apply to.",
"x-enumDescriptions": {
"compute": "Compute commitment type (Savings Plans).",
"database": "Database commitment type (Savings Plans)."
}
},
"settings": {
"allOf": [
{
"type": "object",
"description": "Customer-level recommendation and automation settings for one commitment type. The same values are returned on every AWS organization that has this commitment type activated.",
"required": [
"purchaseMode",
"minimumCommitment",
"lastDayOfMonthForPurchase",
"maximumCommitment",
"term",
"paymentOption",
"policy"
],
"properties": {
"purchaseMode": {
"type": "string",
"enum": [
"autonomous",
"requires_approval"
],
"description": "Whether purchases execute automatically or require customer approval before the planner proceeds. Configured in the DoiT Console Settings tab; this settings API is read-only.",
"x-enumDescriptions": {
"autonomous": "Purchases execute automatically within configured commitment limits. Set in the DoiT Console (Autonomous Purchasing).",
"requires_approval": "Purchases wait for customer approval in the DoiT Console before execution. Default mode; set in Console Settings."
}
},
"minimumCommitment": {
"type": "number",
"format": "double",
"description": "Minimum hourly commitment amount (USD) per purchase step."
},
"lastDayOfMonthForPurchase": {
"type": "integer",
"minimum": 1,
"maximum": 28,
"default": 25,
"description": "Latest calendar day of the month (1–28) on which new purchases may be scheduled. After this day, the No Purchase Window applies until the next month. Default is 25; the maximum allowed value is 28 to leave a buffer before month-end billing cycles."
},
"maximumCommitment": {
"type": "number",
"format": "double",
"description": "Maximum total hourly commitment (USD). `0` means no cap. Always present on settings responses."
},
"term": {
"allOf": [
{
"type": "string",
"enum": [
"one_year",
"three_year"
],
"description": "Preferred or actual commitment term length for Savings Plans and related settings.",
"x-enumDescriptions": {
"one_year": "One-year commitment term.",
"three_year": "Three-year commitment term."
}
}
],
"description": "Preferred commitment term length for new purchases."
},
"paymentOption": {
"allOf": [
{
"type": "string",
"enum": [
"no_upfront",
"partial_upfront",
"all_upfront"
],
"description": "Payment structure for a new or recommended commitment.",
"x-enumDescriptions": {
"no_upfront": "All charges paid monthly; no upfront payment.",
"partial_upfront": "A portion paid upfront; remainder billed monthly.",
"all_upfront": "Full commitment paid upfront."
}
}
],
"description": "Preferred payment structure for new commitments."
},
"policy": {
"allOf": [
{
"type": "string",
"enum": [
"conservative",
"balanced",
"max_savings"
],
"description": "Coverage target policy that balances savings against underutilization risk. Used by recommendations and planned-purchase projections.",
"x-enumDescriptions": {
"conservative": "Lower coverage target (~65%); favors stable usage and lower underutilization risk.",
"balanced": "Moderate coverage target (~80%); default balance of savings and buffer.",
"max_savings": "Aggressive coverage target (~90%); highest savings potential with a smaller buffer."
}
}
],
"description": "Coverage target policy for recommendations and purchases."
},
"upfrontPercentage": {
"type": "number",
"format": "double",
"description": "Fraction of total cost paid upfront (0–1) when `paymentOption` is `partial_upfront`. In the DoiT Console this is set as 50–99% and applies to AWS Compute only; Database uses `no_upfront` only."
}
}
}
],
"description": "Commitment settings for this commitment type."
}
}
},
"description": "Commitment settings for each commitment type activated on this AWS organization. Settings values are customer-level per commitment type."
}
}
}
},
"pageToken": {
"type": "string",
"description": "Opaque cursor for the next page. Absent when this is the last page.",
"nullable": true
},
"rowCount": {
"type": "integer",
"format": "int64",
"description": "Number of items returned in this page."
}
}
}
Errors
On failure, dci prints a single error message — with a hint when one is available — and exits with a typed code your scripts can branch on. See Errors and exit codes for the full contract.
HTTP status to exit code mapping
| HTTP status | Exit code | Error code | Meaning |
|---|---|---|---|
| 400 | 30 | VALIDATION_ERROR | The arguments or request body were rejected. Review the command's flags and payload. |
| 401 | 10 | AUTHENTICATION_FAILED | Not signed in, or the API token is invalid. Run dci login or check DCI_API_KEY. |
| 403 | 11 | PERMISSION_DENIED | The DoiT user or the active customer context does not have access. |
| 500, 503 | 40 | API_SERVER_ERROR | The API failed to process the request. Retryable; contact DoiT support if it persists. |
Related
- list-aws-organizations — List AWS organizations
- get-aws-organization — Get an AWS organization
- list-aws-recommendations — List AWS recommendations
- list-aws-planned-purchases — List AWS planned purchases
- API reference: GET /ps4commitments/v1/aws/settings
Aliases: listawsorganizationssettings