Skip to content

runbooks workspaces collectΒΆ

Auto-generated from runbooks workspaces collect --help on 2026-05-21. Source of truth: runbooks PyPI package v1.3.22

Usage: runbooks workspaces collect [OPTIONS]

  Collect WorkSpace inventory using DescribeWorkspaces paginator.

  Produces a 22-column CSV with workspace metadata, monthly cost, connection
  status, and W1/W2 signal scores. This is Way 1 of the 4-way cross-
  validation.

  Use --all-profile with $AWS_MANAGEMENT_PROFILE to discover all org accounts
  and resolve per-workload profiles automatically. Use --profile for single-
  account collection (default: $AWS_PROFILE).

  Example:

    runbooks workspaces collect --profile $AWS_PROFILE   runbooks workspaces
    collect --all-profile $AWS_MANAGEMENT_PROFILE

Options:
  --profile TEXT       AWS profile for WorkSpaces API (env: AWS_PROFILE).
  --all-profile TEXT   Management profile for multi-account collection (env:
                       AWS_MANAGEMENT_PROFILE). Discovers all accounts via
                       Organizations, resolves per-workload profiles from
                       ~/.aws/config.
  --account-ids TEXT   Comma-separated account IDs to collect (default: uses
                       current session account).
  --output TEXT        Output directory for collect CSV.  [default:
                       tmp/cloudops/workspaces/]
  --quiet              Suppress Rich table output.
  --identity-csv FILE  Path to identity CSV (columns: username/user_name,
                       full_name, email[, persona]). Merges user_full_name and
                       user_persona columns onto inventory rows by username.
  --help               Show this message and exit.

ExamplesΒΆ