Skip to main content

list-billing-transfer-end-customers 

dci list-billing-transfer-end-customers [flags]

Lists the end-customer AWS account mappings under a reseller's program management account, identified by dpmaId and resellerPmaAccountId. Callable by the reseller who owns the PMA or the distributor who owns the DPMA.

Callable by the reseller who owns the PMA or the distributor who owns the DPMA. If you only know the reseller PMA account, list-billing-transfer-end-customers-by-reseller returns the same result without --dpma-id.

Examples​

# End-customer account mappings under one reseller PMA, identified by the distributor PMA and the reseller PMA account.
dci list-billing-transfer-end-customers --dpma-id <dpma-id> --reseller-pma-account-id 123456789012
# Include mappings that have been revoked (excluded by default).
dci list-billing-transfer-end-customers --dpma-id <dpma-id> --reseller-pma-account-id 123456789012 --include-revoked
# Only the account, customer and mapping status columns.
dci list-billing-transfer-end-customers --dpma-id <dpma-id> --reseller-pma-account-id 123456789012 -C ecAccountId,ecCustomerId,status,handshakeState
# The full list as JSON, for scripts.
dci list-billing-transfer-end-customers --dpma-id <dpma-id> --reseller-pma-account-id 123456789012 --output json

Flags​

FlagTypeDefaultExampleDescription
--dpma-idstringDPMA ID that owns the reseller PMA referenced by resellerPmaAccountId.
--reseller-pma-account-idstring12345678901212-digit AWS account ID of the reseller's program management account.
--include-revokedbooleanfalseIf true, includes end-customer mappings that have been revoked. Defaults to false (revoked mappings are excluded).

Every command also accepts the CLI-wide flags for output shaping — see Output formats and Table output options.

Output​

OK

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 object
items[].ecAccountIdstring12-digit AWS account ID of the end-customer account.
items[].ecCustomerIdstringDoiT customer ID the end-customer account is mapped to.
items[].statusstringOne of: "pending", "cur_export_waiting", "active", "canceled", "declined", "expired", "revoked".
items[].handshakeStatestringAWS Organizations Handshake State value, lowercased. One of: "requested", "open", "canceled", "accepted", "declined", "expired".
items[].billSourceTypestring
items[].curBasePathstringS3 key prefix where this end customer's CUR data lands. Omitted when no path was recorded at mapping time.
items[].effectiveTimestring (date-time)When the handshake reached a terminal state. null until then.
items[].createdAtstring (date-time)
items[].lastRefreshTimestring (date-time)When this mapping's status was last refreshed. null if never refreshed.
Raw JSON schema
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "items"
  ],
  "properties": {
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "ecAccountId",
          "ecCustomerId",
          "status",
          "handshakeState",
          "billSourceType",
          "createdAt"
        ],
        "properties": {
          "ecAccountId": {
            "type": "string",
            "description": "12-digit AWS account ID of the end-customer account.",
            "example": "123456789012"
          },
          "ecCustomerId": {
            "type": "string",
            "description": "DoiT customer ID the end-customer account is mapped to."
          },
          "status": {
            "type": "string",
            "enum": [
              "pending",
              "cur_export_waiting",
              "active",
              "canceled",
              "declined",
              "expired",
              "revoked"
            ]
          },
          "handshakeState": {
            "type": "string",
            "description": "AWS Organizations Handshake `State` value, lowercased.",
            "enum": [
              "requested",
              "open",
              "canceled",
              "accepted",
              "declined",
              "expired"
            ]
          },
          "billSourceType": {
            "type": "string"
          },
          "curBasePath": {
            "type": "string",
            "description": "S3 key prefix where this end customer's CUR data lands. Omitted when no path was recorded at mapping time.",
            "example": "cur2/dpma_rpma_ec"
          },
          "effectiveTime": {
            "type": "string",
            "format": "date-time",
            "nullable": true,
            "description": "When the handshake reached a terminal state. `null` until then."
          },
          "createdAt": {
            "type": "string",
            "format": "date-time"
          },
          "lastRefreshTime": {
            "type": "string",
            "format": "date-time",
            "nullable": true,
            "description": "When this mapping's status was last refreshed. `null` if never refreshed."
          }
        }
      }
    }
  }
}

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.
40420RESOURCE_NOT_FOUNDThe requested resource does not exist. Check the identifier argument.
50040API_SERVER_ERRORThe API failed to process the request. Retryable; contact DoiT support if it persists.

Aliases: listbillingtransferendcustomers