メインコンテンツへスキップ

list-customer-notifications

dci list-customer-notifications

Returns every organization notification config for the tenant as an unpaginated \{ "items": [...] \} array. Items are ordered by createTime ascending, then by id ascending. Only configs whose settings use the public types on CustomerNotificationSettings are returned. Dashboard, report, and commitment subscriptions are separate documents and are omitted. A prompt schedule is personal and is omitted. Creating one of those in the Console does not change a config created with this API. Requires the settings (Manage settings) permission. The API does not offer the Console's read-only Organization list; a caller without this permission receives 403.

Output​

OK - Organization notification configs returned.

By default dci renders the result as a table. Use --output json to get the full structure described below — see Output formats.

FieldTypeDescription
itemsarray of objectOrganization notification configs for the tenant, ordered by createTime ascending, then by id ascending. A config that also stores a dashboard, report, or commitment subscription or a prompt schedule is omitted. PATCH and DELETE of that id return 404.
items[].idstringServer-assigned notification id. null only on a dry-run create.
items[].namestringDisplay name of the notification (max 200 characters). The stored name is trimmed.
items[].createTimestring (date-time)When the config was created. null only on a dry-run create.
items[].updateTimestring (date-time)When the config was last changed. null only on a dry-run create.
items[].etagstringCurrent strong ETag as bare SHA-256 hex. The ETag response header and If-Match wrap this value in double quotes. Send that quoted form unchanged on update or delete. null only on a dry-run create.
items[].destinationsobjectDelivery targets. Always includes emails, slackChannels, and teamsChannels. Unused lists are empty arrays.
items[].destinations.emailsarray of string (email)Email addresses that receive the notification, in the order sent. The array is required; an empty array means email is unused. Omitting the array is rejected. At least one of emails, slackChannels, or teamsChannels must be non-empty. Addresses are stored and returned lowercase. A duplicate or an invalid email is 422.
items[].destinations.slackChannelsarray of stringSlack channel ids for Slack channels that receive the notification, in the order sent. The array is required; an empty array means Slack is unused. Omitting the array is rejected. At least one of emails, slackChannels, or teamsChannels must be non-empty. Accepts a public channel, a shared channel, or a private channel the caller is a member of when the DoiT app is also in that channel. A service account cannot add a private channel and receives the same 422 as an id outside the tenant. The caller supplies the id; this API does not look channels up. A duplicate or an id outside the tenant is 422 without saying whether it exists elsewhere. After a channel is accepted, get and list keep returning that id even if the channel is later deleted, archived, or disconnected. That does not mean delivery still works.
items[].destinations.teamsChannelsarray of stringMicrosoft Teams conversation ids for Microsoft Teams channels that receive the notification, in the order sent. The array is required; an empty array means Teams is unused. Omitting the array is rejected. At least one of emails, slackChannels, or teamsChannels must be non-empty. A duplicate or an id outside the tenant is 422 without saying whether it exists elsewhere. A Teams id is also 422 when the tenant has no Teams entitlement. After a channel is accepted, get and list keep returning that id even if the channel is later deleted, archived, or disconnected, or the tenant loses Teams entitlement. That does not mean delivery still works.
items[].settingsobjectSubscribed notification settings. At least one type is required. A config that also stores a dashboard, report, or commitment subscription or a prompt schedule is omitted from list and get. PATCH and DELETE of that id return 404.
items[].settings.newInvoicesobjectBilling profiles this notification applies to. Omit billingProfileIds, or send an empty array, to include every billing profile in the tenant. An id outside the tenant is rejected with 422, the same error as an unknown id.
items[].settings.newInvoices.billingProfileIdsarray of stringBilling-profile ids in this tenant, shaped like ent_01HEXAMPLEBILLING0001. This API does not list billing profiles, and GET /billing/v1/invoices does not return these ids. Empty or omitted means every billing profile in the tenant. A read of an omitted or empty list returns the field absent. An explicit list is returned in the order sent. A duplicate id is rejected with 422.
items[].settings.newProformaInvoicesobjectBilling profiles this notification applies to. Omit billingProfileIds, or send an empty array, to include every billing profile in the tenant. An id outside the tenant is rejected with 422, the same error as an unknown id.
items[].settings.newProformaInvoices.billingProfileIdsarray of stringBilling-profile ids in this tenant, shaped like ent_01HEXAMPLEBILLING0001. This API does not list billing profiles, and GET /billing/v1/invoices does not return these ids. Empty or omitted means every billing profile in the tenant. A read of an omitted or empty list returns the field absent. An explicit list is returned in the order sent. A duplicate id is rejected with 422.
items[].settings.paymentRemindersobjectBilling profiles this notification applies to. Omit billingProfileIds, or send an empty array, to include every billing profile in the tenant. An id outside the tenant is rejected with 422, the same error as an unknown id.
items[].settings.paymentReminders.billingProfileIdsarray of stringBilling-profile ids in this tenant, shaped like ent_01HEXAMPLEBILLING0001. This API does not list billing profiles, and GET /billing/v1/invoices does not return these ids. Empty or omitted means every billing profile in the tenant. A read of an omitted or empty list returns the field absent. An explicit list is returned in the order sent. A duplicate id is rejected with 422.
items[].settings.creditUtilizationobjectA present empty object means this type is subscribed, for example "creditUtilization": \{\}. The object has no fields. On a patch property, null unsubscribes that type and is a different value.
items[].settings.quotaUtilizationobjectA present empty object means this type is subscribed, for example "creditUtilization": \{\}. The object has no fields. On a patch property, null unsubscribes that type and is a different value.
items[].settings.cloudIncidentsobjectA present empty object means this type is subscribed, for example "creditUtilization": \{\}. The object has no fields. On a patch property, null unsubscribes that type and is a different value.
items[].settings.newSkuUsageobjectA present empty object means this type is subscribed, for example "creditUtilization": \{\}. The object has no fields. On a patch property, null unsubscribes that type and is a different value.
items[].settings.dailyDigestobjectAllocation rules included in a daily or weekly digest. At least one id is required.
items[].settings.dailyDigest.allocationIdsarray of stringAllocation rule ids from GET /analytics/v1/allocations. At least one id is required. A read returns the ids in the order sent. A duplicate, or an id outside the tenant, is rejected with 422.
items[].settings.weeklyDigestobjectAllocation rules included in a daily or weekly digest. At least one id is required.
items[].settings.weeklyDigest.allocationIdsarray of stringAllocation rule ids from GET /analytics/v1/allocations. At least one id is required. A read returns the ids in the order sent. A duplicate, or an id outside the tenant, is rejected with 422.
items[].settings.monthlyDigestobjectA present empty object means this type is subscribed, for example "creditUtilization": \{\}. The object has no fields. On a patch property, null unsubscribes that type and is a different value.
items[].settings.expertInsightsobjectA present empty object means this type is subscribed, for example "creditUtilization": \{\}. The object has no fields. On a patch property, null unsubscribes that type and is a different value.
items[].settings.insightsobjectOptional insight filters. An empty or omitted list means every value of that filter. An insight must match every criterion across pillars, severities, and providers. A read of an omitted or empty list returns that field absent. An explicit list is returned in the order sent. A repeated value is rejected with 422.
items[].settings.insights.pillarsarray of stringInsight pillars. Empty or omitted means all pillars.
items[].settings.insights.severitiesarray of stringInsight severities. Empty or omitted means all severities.
items[].settings.insights.providersarray of stringInsights provider ids such as aws, gcp, azure, azure-ad, general, google-cloud-source, google-workspace, k8s, oci, and vmware. These are the ids Insights resources use, not invoice platform ids such as amazon-web-services. Empty or omitted means all providers. Available ids depend on the tenant's connected accounts. Each value is a non-empty string.
items[].settings.costAnomaliesobjectCost-anomaly notification settings: minimum severity, excess-cost threshold, allocation scope, and optional resend controls.
items[].settings.costAnomalies.minSeveritystringwarning — warning and above. critical — critical only. There is no information or all value; a write of all is rejected with 422. Clients may send only warning or critical. Responses return only warning or critical. A missing or empty stored severity (console "All severity levels") is returned as warning. critical is stored and returned as critical. One of: "warning", "critical".
items[].settings.costAnomalies.minExcessCostobjectMinimum excess cost, as Money. Notify when excess cost is above this amount, not total spend. 100.00 USD means $100. currency must be USD; any other currency is rejected with 422. A negative amount is rejected with 422. A fractional amount is rejected with 422 (100.99 is not a whole number of dollars). 100 and 100.00 are both accepted. 0 and 0.00 are accepted. Amounts above 1,000,000,000 whole dollars, and forms such as Inf, exponents, a leading +, or underscores, are rejected with 422. Responses return the amount as "100.00". Nested fields omitted — see the raw JSON schema.
items[].settings.costAnomalies.allocationsobjectAllocation scope for cost-anomaly notifications. ids are allocation ids from GET /analytics/v1/allocations. An id outside the caller's tenant is rejected with 422 without saying whether it exists elsewhere. mode: all means every allocation with anomaly detection enabled, including anomalies that are not tied to an allocation, and it carries an empty ids. include and exclude require at least one id. mode: all with a non-empty ids, and include or exclude with an empty ids, are rejected with 422. ids are an ordered list: the server stores and returns them in the order sent, and it does not sort or drop entries. A duplicate id is rejected with 422. Nested fields omitted — see the raw JSON schema.
items[].settings.costAnomalies.repeatobjectResend controls for an active cost anomaly. Omit the whole repeat object when neither control is set. An empty object is rejected with 422. Nested fields omitted — see the raw JSON schema.
items[].settings.savingsPlanApprovalobjectA present empty object means this type is subscribed, for example "creditUtilization": \{\}. The object has no fields. On a patch property, null unsubscribes that type and is a different value.
items[].settings.savingsPlanPurchasedobjectA present empty object means this type is subscribed, for example "creditUtilization": \{\}. The object has no fields. On a patch property, null unsubscribes that type and is a different value.
items[].settings.cudApprovalobjectA present empty object means this type is subscribed, for example "creditUtilization": \{\}. The object has no fields. On a patch property, null unsubscribes that type and is a different value.
items[].settings.cudPurchasedobjectA present empty object means this type is subscribed, for example "creditUtilization": \{\}. The object has no fields. On a patch property, null unsubscribes that type and is a different value.
items[].settings.dataIntegrationSyncFailureobjectA present empty object means this type is subscribed, for example "creditUtilization": \{\}. The object has no fields. On a patch property, null unsubscribes that type and is a different value.
items[].settings.awsBillingDataImportobjectBilling profiles this notification applies to. Omit billingProfileIds, or send an empty array, to include every billing profile in the tenant. An id outside the tenant is rejected with 422, the same error as an unknown id.
items[].settings.awsBillingDataImport.billingProfileIdsarray of stringBilling-profile ids in this tenant, shaped like ent_01HEXAMPLEBILLING0001. This API does not list billing profiles, and GET /billing/v1/invoices does not return these ids. Empty or omitted means every billing profile in the tenant. A read of an omitted or empty list returns the field absent. An explicit list is returned in the order sent. A duplicate id is rejected with 422.

Example response (--output json)​

{
"items": [
{
"id": "notif_01HX9P2KQVJ8Z3M4T5N6V7W8Y9",
"name": "Anomaly alerts",
"createTime": "2026-10-01T08:00:00Z",
"updateTime": "2026-10-01T08:00:00Z",
"etag": "3f7a1c9e2b4d6f8a0c1e3a5b7d9f1b3d5f7a9c1e3b5d7f9a1c3e5b7d9f1a3c5e",
"destinations": {
"emails": [
],
"slackChannels": [
"C0123ABCD"
],
"teamsChannels": [
]
},
"settings": {
"costAnomalies": {
"minSeverity": "warning",
"minExcessCost": {
"amount": "100.00",
"currency": "USD"
},
"allocations": {
"mode": "include",
"ids": [
"alloc_abc",
"alloc_def"
]
},
"repeat": {
"everyHours": 24,
"whenCostGrows": {
"match": "or",
"percentIncrease": 10,
"minIncrease": {
"amount": "150.00",
"currency": "USD"
},
"withinHours": 6
}
}
}
}
}
]
}
Raw JSON schema
{
"type": "object",
"additionalProperties": false,
"description": "Unpaginated list of organization-wide notification configs.",
"required": [
"items"
],
"properties": {
"items": {
"type": "array",
"description": "Organization notification configs for the tenant, ordered by `createTime` ascending, then by `id` ascending. A config that also stores a dashboard, report, or commitment subscription or a prompt schedule is omitted. PATCH and DELETE of that id return `404`.",
"items": {
"type": "object",
"additionalProperties": false,
"description": "Organization-wide notification config. Create and read return the full resource with the same field names. Update and delete require `If-Match` against the strong `etag`.",
"required": [
"id",
"name",
"createTime",
"updateTime",
"etag",
"destinations",
"settings"
],
"properties": {
"id": {
"type": "string",
"readOnly": true,
"x-terraform-computed": true,
"description": "Server-assigned notification id. `null` only on a dry-run create.",
"nullable": true,
"example": "notif_01HX9P2KQVJ8Z3M4T5N6V7W8Y9"
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 200,
"description": "Display name of the notification (max 200 characters). The stored name is trimmed.",
"example": "Anomaly alerts"
},
"createTime": {
"type": "string",
"format": "date-time",
"readOnly": true,
"x-terraform-computed": true,
"description": "When the config was created. `null` only on a dry-run create.",
"nullable": true,
"example": "2026-10-01T08:00:00Z"
},
"updateTime": {
"type": "string",
"format": "date-time",
"readOnly": true,
"x-terraform-computed": true,
"description": "When the config was last changed. `null` only on a dry-run create.",
"nullable": true,
"example": "2026-10-01T08:00:00Z"
},
"etag": {
"type": "string",
"readOnly": true,
"x-terraform-computed": true,
"description": "Current strong ETag as bare SHA-256 hex. The `ETag` response header and `If-Match` wrap this value in double quotes. Send that quoted form unchanged on update or delete. `null` only on a dry-run create.",
"nullable": true,
"example": "3f7a1c9e2b4d6f8a0c1e3a5b7d9f1b3d5f7a9c1e3b5d7f9a1c3e5b7d9f1a3c5e"
},
"destinations": {
"description": "Delivery targets. Always includes `emails`, `slackChannels`, and `teamsChannels`. Unused lists are empty arrays.",
"allOf": [
{
"type": "object",
"additionalProperties": false,
"description": "Delivery targets for an organization notification. All three arrays are always present on read. An unused destination is an empty array, never omitted and never `null`. On create, and on a patch that includes `destinations`, all three arrays are required and at least one must be non-empty. An object whose three arrays are all empty is rejected with `422`. Each array is kept in the order sent; a later read returns that same order. Emails are trimmed and stored lowercase. Channel ids are trimmed and otherwise unchanged. A duplicate value inside one array is rejected with `422` (emails compared after lowercase; channel ids compared exactly after trim).",
"required": [
"emails",
"slackChannels",
"teamsChannels"
],
"properties": {
"emails": {
"type": "array",
"minItems": 0,
"description": "Email addresses that receive the notification, in the order sent. The array is required; an empty array means email is unused. Omitting the array is rejected. At least one of `emails`, `slackChannels`, or `teamsChannels` must be non-empty. Addresses are stored and returned lowercase. A duplicate or an invalid email is `422`.",
"items": {
"type": "string",
"format": "email",
"minLength": 1,
"x-doit-pii": true
},
"example": [
]
},
"slackChannels": {
"type": "array",
"minItems": 0,
"description": "Slack channel ids for Slack channels that receive the notification, in the order sent. The array is required; an empty array means Slack is unused. Omitting the array is rejected. At least one of `emails`, `slackChannels`, or `teamsChannels` must be non-empty. Accepts a public channel, a shared channel, or a private channel the caller is a member of when the DoiT app is also in that channel. A service account cannot add a private channel and receives the same `422` as an id outside the tenant. The caller supplies the id; this API does not look channels up. A duplicate or an id outside the tenant is `422` without saying whether it exists elsewhere. After a channel is accepted, get and list keep returning that id even if the channel is later deleted, archived, or disconnected. That does not mean delivery still works.",
"items": {
"type": "string",
"minLength": 1
},
"example": [
"C0123ABCD"
]
},
"teamsChannels": {
"type": "array",
"minItems": 0,
"description": "Microsoft Teams conversation ids for Microsoft Teams channels that receive the notification, in the order sent. The array is required; an empty array means Teams is unused. Omitting the array is rejected. At least one of `emails`, `slackChannels`, or `teamsChannels` must be non-empty. A duplicate or an id outside the tenant is `422` without saying whether it exists elsewhere. A Teams id is also `422` when the tenant has no Teams entitlement. After a channel is accepted, get and list keep returning that id even if the channel is later deleted, archived, or disconnected, or the tenant loses Teams entitlement. That does not mean delivery still works.",
"items": {
"type": "string",
"minLength": 1
},
"example": [
]
}
}
}
]
},
"settings": {
"description": "Subscribed notification settings. At least one type is required. A config that also stores a dashboard, report, or commitment subscription or a prompt schedule is omitted from list and get. PATCH and DELETE of that id return `404`.",
"allOf": [
{
"type": "object",
"additionalProperties": false,
"minProperties": 1,
"description": "Subscribed notification settings, one property per type. A present property subscribes that type;\n`{}` subscribes a type that has no fields. Omitting a property on create leaves that type\nunsubscribed. At least one property is required. Unknown properties, including dashboard, report,\nand commitment subscriptions, prompt schedules, and `conditions`, are rejected with `422`.\n\nProperties and their Console labels:\n\n- `newInvoices`: New invoices\n- `newProformaInvoices`: New proforma invoices\n- `paymentReminders`: Due or overdue payments\n- `creditUtilization`: Credit utilization\n- `quotaUtilization`: Quota utilization\n- `cloudIncidents`: Cloud incidents\n- `newSkuUsage`: New SKUs usage detected\n- `dailyDigest`: Daily digest, one email per selected allocation rule each day\n- `weeklyDigest`: Weekly digest, one email per selected allocation rule each week\n- `monthlyDigest`: Monthly digest\n- `expertInsights`: Third-party insights (Console item \"New insights recommended by DoiT experts\")\n- `insights`: New insights\n- `costAnomalies`: Cloud cost anomalies (Console item \"Cost anomaly detection\")\n- `savingsPlanApproval`: Savings Plan purchase requires approval (PerfectScale for Commitments)\n- `savingsPlanPurchased`: Savings Plan purchased\n- `cudApproval`: committed use discount (CUD) purchase requires approval\n- `cudPurchased`: CUD purchased\n- `dataIntegrationSyncFailure`: Data integration sync failures\n- `awsBillingDataImport`: AWS Billing Data Import Alert\n\nRequires Manage settings; no other permission is checked.\n\nEvery destination channel must be supported by every subscribed type, or the response is `422`\n`customers.channel_not_supported`:\n\n- Email and Slack only: `expertInsights`, `dataIntegrationSyncFailure`\n- Email, Slack, and Microsoft Teams: every other property\n- A Teams destination on a supported type is still `422` `validation_failed` when the tenant has\n no Teams entitlement",
"properties": {
"newInvoices": {
"type": "object",
"additionalProperties": false,
"description": "Billing profiles this notification applies to. Omit `billingProfileIds`, or send an empty array, to include every billing profile in the tenant. An id outside the tenant is rejected with `422`, the same error as an unknown id.",
"properties": {
"billingProfileIds": {
"type": "array",
"description": "Billing-profile ids in this tenant, shaped like `ent_01HEXAMPLEBILLING0001`. This API does not list billing profiles, and `GET /billing/v1/invoices` does not return these ids. Empty or omitted means every billing profile in the tenant. A read of an omitted or empty list returns the field absent. An explicit list is returned in the order sent. A duplicate id is rejected with `422`.",
"items": {
"type": "string",
"minLength": 1,
"example": "ent_01HEXAMPLEBILLING0001"
}
}
}
},
"newProformaInvoices": {
"type": "object",
"additionalProperties": false,
"description": "Billing profiles this notification applies to. Omit `billingProfileIds`, or send an empty array, to include every billing profile in the tenant. An id outside the tenant is rejected with `422`, the same error as an unknown id.",
"properties": {
"billingProfileIds": {
"type": "array",
"description": "Billing-profile ids in this tenant, shaped like `ent_01HEXAMPLEBILLING0001`. This API does not list billing profiles, and `GET /billing/v1/invoices` does not return these ids. Empty or omitted means every billing profile in the tenant. A read of an omitted or empty list returns the field absent. An explicit list is returned in the order sent. A duplicate id is rejected with `422`.",
"items": {
"type": "string",
"minLength": 1,
"example": "ent_01HEXAMPLEBILLING0001"
}
}
}
},
"paymentReminders": {
"type": "object",
"additionalProperties": false,
"description": "Billing profiles this notification applies to. Omit `billingProfileIds`, or send an empty array, to include every billing profile in the tenant. An id outside the tenant is rejected with `422`, the same error as an unknown id.",
"properties": {
"billingProfileIds": {
"type": "array",
"description": "Billing-profile ids in this tenant, shaped like `ent_01HEXAMPLEBILLING0001`. This API does not list billing profiles, and `GET /billing/v1/invoices` does not return these ids. Empty or omitted means every billing profile in the tenant. A read of an omitted or empty list returns the field absent. An explicit list is returned in the order sent. A duplicate id is rejected with `422`.",
"items": {
"type": "string",
"minLength": 1,
"example": "ent_01HEXAMPLEBILLING0001"
}
}
}
},
"creditUtilization": {
"type": "object",
"additionalProperties": false,
"description": "A present empty object means this type is subscribed, for example `\"creditUtilization\": {}`. The object has no fields. On a patch property, `null` unsubscribes that type and is a different value.",
"example": {}
},
"quotaUtilization": {
"type": "object",
"additionalProperties": false,
"description": "A present empty object means this type is subscribed, for example `\"creditUtilization\": {}`. The object has no fields. On a patch property, `null` unsubscribes that type and is a different value.",
"example": {}
},
"cloudIncidents": {
"type": "object",
"additionalProperties": false,
"description": "A present empty object means this type is subscribed, for example `\"creditUtilization\": {}`. The object has no fields. On a patch property, `null` unsubscribes that type and is a different value.",
"example": {}
},
"newSkuUsage": {
"type": "object",
"additionalProperties": false,
"description": "A present empty object means this type is subscribed, for example `\"creditUtilization\": {}`. The object has no fields. On a patch property, `null` unsubscribes that type and is a different value.",
"example": {}
},
"dailyDigest": {
"type": "object",
"additionalProperties": false,
"description": "Allocation rules included in a daily or weekly digest. At least one id is required.",
"required": [
"allocationIds"
],
"properties": {
"allocationIds": {
"type": "array",
"minItems": 1,
"description": "Allocation rule ids from `GET /analytics/v1/allocations`. At least one id is required. A read returns the ids in the order sent. A duplicate, or an id outside the tenant, is rejected with `422`.",
"items": {
"type": "string",
"minLength": 1,
"example": "alloc_abc"
}
}
}
},
"weeklyDigest": {
"type": "object",
"additionalProperties": false,
"description": "Allocation rules included in a daily or weekly digest. At least one id is required.",
"required": [
"allocationIds"
],
"properties": {
"allocationIds": {
"type": "array",
"minItems": 1,
"description": "Allocation rule ids from `GET /analytics/v1/allocations`. At least one id is required. A read returns the ids in the order sent. A duplicate, or an id outside the tenant, is rejected with `422`.",
"items": {
"type": "string",
"minLength": 1,
"example": "alloc_abc"
}
}
}
},
"monthlyDigest": {
"type": "object",
"additionalProperties": false,
"description": "A present empty object means this type is subscribed, for example `\"creditUtilization\": {}`. The object has no fields. On a patch property, `null` unsubscribes that type and is a different value.",
"example": {}
},
"expertInsights": {
"type": "object",
"additionalProperties": false,
"description": "A present empty object means this type is subscribed, for example `\"creditUtilization\": {}`. The object has no fields. On a patch property, `null` unsubscribes that type and is a different value.",
"example": {}
},
"insights": {
"type": "object",
"additionalProperties": false,
"description": "Optional insight filters. An empty or omitted list means every value of that filter. An insight must match every criterion across `pillars`, `severities`, and `providers`. A read of an omitted or empty list returns that field absent. An explicit list is returned in the order sent. A repeated value is rejected with `422`.",
"properties": {
"pillars": {
"type": "array",
"description": "Insight pillars. Empty or omitted means all pillars.",
"items": {
"type": "string",
"enum": [
"cost",
"operations",
"performance",
"security",
"compliance"
],
"x-enumDescriptions": {
"cost": "Cost. Notify for insights in the Cost category.",
"operations": "Operations. Notify for insights in the Operations category.",
"performance": "Performance. Notify for insights in the Performance category.",
"security": "Security. Notify for insights in the Security category.",
"compliance": "Compliance. Notify for insights in the Compliance category."
}
}
},
"severities": {
"type": "array",
"description": "Insight severities. Empty or omitted means all severities.",
"items": {
"type": "string",
"enum": [
"critical",
"high",
"medium",
"low"
],
"x-enumDescriptions": {
"critical": "Critical. Notify for Critical insights.",
"high": "High. Notify for High insights.",
"medium": "Medium. Notify for Medium insights.",
"low": "Low. Notify for Low insights."
}
}
},
"providers": {
"type": "array",
"description": "Insights provider ids such as `aws`, `gcp`, `azure`, `azure-ad`, `general`, `google-cloud-source`, `google-workspace`, `k8s`, `oci`, and `vmware`. These are the ids Insights resources use, not invoice platform ids such as `amazon-web-services`. Empty or omitted means all providers. Available ids depend on the tenant's connected accounts. Each value is a non-empty string.",
"items": {
"type": "string",
"minLength": 1,
"example": "aws"
}
}
}
},
"costAnomalies": {
"type": "object",
"additionalProperties": false,
"description": "Cost-anomaly notification settings: minimum severity, excess-cost threshold, allocation scope, and\noptional resend controls.\n",
"required": [
"minSeverity",
"minExcessCost",
"allocations"
],
"properties": {
"minSeverity": {
"type": "string",
"enum": [
"warning",
"critical"
],
"x-enumDescriptions": {
"warning": "Warning and above. A missing stored severity (Console \"All severity levels\") is also returned as `warning`.",
"critical": "Critical."
},
"description": "`warning` — warning and above. `critical` — critical only. There is no `information` or `all` value; a write of `all` is rejected with `422`. Clients may send only `warning` or `critical`. Responses return only `warning` or `critical`. A missing or empty stored severity (console \"All severity levels\") is returned as `warning`. `critical` is stored and returned as `critical`.",
"example": "warning"
},
"minExcessCost": {
"description": "Minimum excess cost, as Money. Notify when excess cost is above this amount, not total spend.\n`100.00` USD means $100. `currency` must be `USD`; any other currency is rejected with `422`. A\nnegative amount is rejected with `422`. A fractional amount is rejected with `422` (`100.99` is not a\nwhole number of dollars). `100` and `100.00` are both accepted. `0` and `0.00` are accepted. Amounts\nabove 1,000,000,000 whole dollars, and forms such as `Inf`, exponents, a leading `+`, or underscores,\nare rejected with `422`. Responses return the amount as `\"100.00\"`.\n",
"allOf": [
{
"type": "object",
"required": [
"amount",
"currency"
],
"properties": {
"amount": {
"type": "string",
"pattern": "^-?(0|[1-9]\\d*)(\\.\\d+)?$",
"description": "Decimal monetary amount at ISO 4217 minor-unit precision (string).",
"example": "100.00"
},
"currency": {
"type": "string",
"pattern": "^[A-Z]{3}$",
"description": "ISO 4217 currency code.",
"example": "USD"
}
}
}
]
},
"allocations": {
"type": "object",
"additionalProperties": false,
"description": "Allocation scope for cost-anomaly notifications. `ids` are allocation ids from `GET\n/analytics/v1/allocations`. An id outside the caller's tenant is rejected with `422` without saying\nwhether it exists elsewhere.\n\n`mode: all` means every allocation with anomaly detection enabled, including anomalies that are not\ntied to an allocation, and it carries an empty `ids`. `include` and `exclude` require at least one\nid. `mode: all` with a non-empty `ids`, and `include` or `exclude` with an empty `ids`, are rejected\nwith `422`. `ids` are an ordered list: the server stores and returns them in the order sent, and it does\nnot sort or drop entries. A duplicate id is rejected with `422`.\n",
"required": [
"mode",
"ids"
],
"properties": {
"mode": {
"type": "string",
"enum": [
"all",
"include",
"exclude"
],
"x-enumDescriptions": {
"all": "Include all enabled allocations, including anomalies that are not tied to an allocation. Send an empty `ids`.",
"include": "Include specific allocations. Requires at least one id.",
"exclude": "Exclude specific allocations. Requires at least one id."
},
"description": "`all` — every allocation with anomaly detection enabled (and unallocated anomalies). `include` — only the listed ids. `exclude` — all enabled allocations except the listed ids. `all` cannot be sent with a non-empty `ids`. `include` and `exclude` cannot be sent with an empty `ids`.",
"example": "include"
},
"ids": {
"type": "array",
"description": "Allocation ids, in the order sent. A read returns that same order. A duplicate id is rejected\nwith `422`. Empty when `mode` is `all`. Non-empty when `mode` is `include` or `exclude`.\n",
"items": {
"type": "string",
"minLength": 1
},
"example": [
"alloc_abc",
"alloc_def"
]
}
}
},
"repeat": {
"type": "object",
"additionalProperties": false,
"minProperties": 1,
"description": "Resend controls for an active cost anomaly. Omit the whole `repeat` object when neither control is\nset. An empty object is rejected with `422`.\n",
"properties": {
"everyHours": {
"type": "integer",
"minimum": 1,
"maximum": 24,
"description": "Resend until the anomaly is inactive, every N hours (1–24).\n",
"example": 24
},
"whenCostGrows": {
"type": "object",
"additionalProperties": false,
"minProperties": 1,
"description": "Resend when the anomaly's cost grows. At least one of `percentIncrease` or `minIncrease` is required.\nAn object with only `withinHours`, only `match`, or neither amount is rejected with `422`.\n\n- both `percentIncrease` and `minIncrease` present → `match` is\n required (`or` or `and`)\n- exactly one of `percentIncrease` or `minIncrease` present → omit\n `match` (percentage-only or value-only)\n- neither amount present → rejected with `422`\n\n`percentIncrease` is an integer percent (`10` means 10 percent) and must be at least 1. Omit\n`withinHours` when the time window is off.",
"properties": {
"match": {
"type": "string",
"enum": [
"or",
"and"
],
"x-enumDescriptions": {
"or": "Resend when either the percent increase or the dollar increase is reached.",
"and": "Resend only when both are reached."
},
"description": "How to combine percent and dollar growth when both are set. Required when both amounts are present; omit when only one amount is present.",
"example": "or"
},
"percentIncrease": {
"type": "integer",
"minimum": 1,
"description": "Minimum percent cost increase that triggers a resend. `10` means 10 percent. Must be greater than 0.\n",
"example": 10
},
"minIncrease": {
"description": "Minimum cost growth that triggers a resend, as Money. Must be a positive whole number of dollars.\n`150.00` USD means $150. `currency` must be `USD`; any other currency is rejected with `422`. `0`,\n`0.00`, and a negative amount are rejected with `422`. A fractional amount is rejected with `422`\n(`150.99` is not a whole number of dollars). `150` and `150.00` are both accepted. Amounts above\n1,000,000,000 whole dollars, and forms such as `Inf`, exponents, a leading `+`, or underscores, are\nrejected with `422`. Responses return the amount as `\"150.00\"`.\n",
"allOf": [
{
"type": "object",
"required": [
"amount",
"currency"
],
"properties": {
"amount": {
"type": "string",
"pattern": "^-?(0|[1-9]\\d*)(\\.\\d+)?$",
"description": "Decimal monetary amount at ISO 4217 minor-unit precision (string).",
"example": "100.00"
},
"currency": {
"type": "string",
"pattern": "^[A-Z]{3}$",
"description": "ISO 4217 currency code.",
"example": "USD"
}
}
}
]
},
"withinHours": {
"type": "integer",
"minimum": 1,
"maximum": 24,
"description": "Optional window in hours for the growth check (1–24).",
"example": 6
}
}
}
}
}
}
},
"savingsPlanApproval": {
"type": "object",
"additionalProperties": false,
"description": "A present empty object means this type is subscribed, for example `\"creditUtilization\": {}`. The object has no fields. On a patch property, `null` unsubscribes that type and is a different value.",
"example": {}
},
"savingsPlanPurchased": {
"type": "object",
"additionalProperties": false,
"description": "A present empty object means this type is subscribed, for example `\"creditUtilization\": {}`. The object has no fields. On a patch property, `null` unsubscribes that type and is a different value.",
"example": {}
},
"cudApproval": {
"type": "object",
"additionalProperties": false,
"description": "A present empty object means this type is subscribed, for example `\"creditUtilization\": {}`. The object has no fields. On a patch property, `null` unsubscribes that type and is a different value.",
"example": {}
},
"cudPurchased": {
"type": "object",
"additionalProperties": false,
"description": "A present empty object means this type is subscribed, for example `\"creditUtilization\": {}`. The object has no fields. On a patch property, `null` unsubscribes that type and is a different value.",
"example": {}
},
"dataIntegrationSyncFailure": {
"type": "object",
"additionalProperties": false,
"description": "A present empty object means this type is subscribed, for example `\"creditUtilization\": {}`. The object has no fields. On a patch property, `null` unsubscribes that type and is a different value.",
"example": {}
},
"awsBillingDataImport": {
"type": "object",
"additionalProperties": false,
"description": "Billing profiles this notification applies to. Omit `billingProfileIds`, or send an empty array, to include every billing profile in the tenant. An id outside the tenant is rejected with `422`, the same error as an unknown id.",
"properties": {
"billingProfileIds": {
"type": "array",
"description": "Billing-profile ids in this tenant, shaped like `ent_01HEXAMPLEBILLING0001`. This API does not list billing profiles, and `GET /billing/v1/invoices` does not return these ids. Empty or omitted means every billing profile in the tenant. A read of an omitted or empty list returns the field absent. An explicit list is returned in the order sent. A duplicate id is rejected with `422`.",
"items": {
"type": "string",
"minLength": 1,
"example": "ent_01HEXAMPLEBILLING0001"
}
}
}
}
}
}
]
}
}
},
"example": []
}
},
"example": {
"items": []
}
}

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 statusExit codeError codeMeaning
40030VALIDATION_ERRORThe arguments or request body were rejected. Review the command's flags and payload.
40110AUTHENTICATION_FAILEDNot signed in, or the API token is invalid. Run dci login or check DCI_API_KEY.
40311PERMISSION_DENIEDThe DoiT user or the active customer context does not have access.
50040API_SERVER_ERRORThe API failed to process the request. Retryable; contact DoiT support if it persists.

Aliases: listcustomernotifications