list-billing-transfer-program-management-accounts

dci list-billing-transfer-program-management-accounts [flags]

Lists the caller's program management accounts (PMAs) and the reseller tenants mapped to each one, including AWS Organizations handshake status per account. Distributor-only.

Flags

--max-results: (integer format:int64 default:50)

--page-token: (string)

Responses

200 (application/json)

OK

{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "items",
    "rowCount"
  ],
  "properties": {
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "dpmaId",
          "accountId",
          "roleArn",
          "stackName",
          "region",
          "iamStatus",
          "createdAt",
          "tenants",
          "handshakeStatus"
        ],
        "properties": {
          "dpmaId": {
            "type": "string"
          },
          "accountId": {
            "type": "string",
            "description": "12-digit AWS account ID of the program management account.",
            "example": "123456789012"
          },
          "roleArn": {
            "type": "string"
          },
          "stackName": {
            "type": "string"
          },
          "region": {
            "type": "string"
          },
          "iamStatus": {
            "type": "string"
          },
          "iamDiff": {
            "allOf": [
              {
                "type": "object",
                "additionalProperties": false,
                "properties": {
                  "missing": {
                    "type": "array",
                    "items": {
                      "type": "string"
                    }
                  },
                  "extra": {
                    "type": "array",
                    "items": {
                      "type": "string"
                    }
                  }
                }
              }
            ],
            "nullable": true,
            "description": "Present when `iamStatus` indicates drift. `null` when the deployed IAM matches expectations."
          },
          "createdAt": {
            "type": "string",
            "format": "date-time"
          },
          "lastRefreshTime": {
            "type": "string",
            "format": "date-time",
            "nullable": true,
            "description": "When this account's handshake/tenant state was last refreshed. `null` if never refreshed."
          },
          "tenants": {
            "type": "array",
            "items": {
              "type": "object",
              "additionalProperties": false,
              "required": [
                "customerId",
                "tenantType",
                "parentTenant",
                "displayName",
                "resellerPmaAccountId",
                "handshakeState",
                "status"
              ],
              "properties": {
                "customerId": {
                  "type": "string"
                },
                "tenantType": {
                  "type": "string"
                },
                "parentTenant": {
                  "type": "string"
                },
                "displayName": {
                  "type": "string"
                },
                "resellerPmaAccountId": {
                  "type": "string",
                  "example": "123456789012"
                },
                "handshakeState": {
                  "type": "string",
                  "description": "AWS Organizations Handshake `State` value, lowercased.",
                  "enum": [
                    "requested",
                    "open",
                    "canceled",
                    "accepted",
                    "declined",
                    "expired"
                  ]
                },
                "status": {
                  "type": "string"
                },
                "effectiveTime": {
                  "type": "string",
                  "format": "date-time",
                  "nullable": true,
                  "description": "When the handshake reached a terminal state. `null` until then."
                }
              }
            }
          },
          "handshakeStatus": {
            "type": "object",
            "description": "Per-AWS-Organizations-handshake-state counts across all tenants mapped to a PMA.",
            "additionalProperties": false,
            "required": [
              "total",
              "requested",
              "open",
              "accepted",
              "declined",
              "canceled",
              "expired"
            ],
            "properties": {
              "total": {
                "type": "integer"
              },
              "requested": {
                "type": "integer"
              },
              "open": {
                "type": "integer"
              },
              "accepted": {
                "type": "integer"
              },
              "declined": {
                "type": "integer"
              },
              "canceled": {
                "type": "integer"
              },
              "expired": {
                "type": "integer"
              }
            }
          }
        }
      }
    },
    "pageToken": {
      "type": "string",
      "description": "Opaque cursor for the next page. Absent when this is the last page."
    },
    "rowCount": {
      "type": "integer"
    }
  }
}

400 (application/json)

Bad Request - The server cannot process the request, often due to a malformed request.

{
  "type": "object",
  "description": "Standard error response structure.",
  "properties": {
    "error": {
      "type": "string",
      "description": "Detailed error message."
    }
  }
}

401 (application/json)

Unauthorized - Invalid API key.

{
  "type": "object",
  "description": "Standard error response structure.",
  "properties": {
    "error": {
      "type": "string",
      "description": "Detailed error message."
    }
  }
}

403 (application/json)

Forbidden - The client is not authorized to perform the request.

{
  "type": "object",
  "description": "Standard error response structure.",
  "properties": {
    "error": {
      "type": "string",
      "description": "Detailed error message."
    }
  }
}

500 (application/json)

Internal Server Error - Something went wrong with the DoiT API server.

{
  "type": "object",
  "description": "Standard error response structure.",
  "properties": {
    "error": {
      "type": "string",
      "description": "Detailed error message."
    }
  }
}

Aliases: listbillingtransferprogrammanagementaccounts