Skip to content

runbooks inventory collectΒΆ

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

Usage: runbooks inventory collect [OPTIONS]

  πŸ” Universal AWS resource inventory collection - works with ANY AWS
  environment.

  βœ… Universal Compatibility Features: - Works with single accounts, AWS
  Organizations, and standalone setups - Profile override priority: User >
  Environment > Default ('default' profile fallback) - Intelligent
  Organizations detection with graceful standalone fallback - 50+ AWS services
  discovery across any account configuration - Multi-format exports: CSV,
  JSON, PDF, Markdown, YAML - MCP validation for β‰₯99.5% accuracy

  Universal Profile Usage: - ANY AWS profile works (no hardcoded assumptions)
  - Organizations permissions auto-detected (graceful fallback to single
  account) - AWS_PROFILE environment variable used when available - 'default'
  profile used as universal fallback

  Examples:     # Universal compatibility - works with any AWS setup
  runbooks inventory collect                                    # Default
  profile     runbooks inventory collect --profile my-aws-profile           #
  Any profile     runbooks inventory collect --all
  # Organizations auto-discovery (uses AWS_MANAGEMENT_PROFILE)

      # Resource-specific discovery     runbooks inventory collect --resources
      ec2,rds,s3             # Specific services     runbooks inventory
      collect --all-resources                    # All 50+ services

      # Multi-format exports     runbooks inventory collect --csv --json --pdf
      # Multiple formats     runbooks inventory collect --profile prod
      --validate --markdown

Options:
  -p, --profile TEXT              AWS profile name (default: from AWS_PROFILE
                                  env var)
  -r, --resources TEXT            Resource types (ec2, rds, lambda, s3, etc.)
  --exclude-resources TEXT        Resource types to exclude from collection
                                  (inverse of --resources)
  --all-resources                 Collect all resource types
  --all                           Multi-account discovery via Organizations
                                  API. Auto-detects management profile from
                                  AWS_MANAGEMENT_PROFILE env var.
  --all-regions                   Execute inventory collection across all AWS
                                  regions
  --max-concurrent-profiles INTEGER
                                  Maximum concurrent profile operations for
                                  rate limit control
  --retry-attempts INTEGER        Number of retry attempts for failed API
                                  calls
  --inventory-timeout INTEGER     Maximum inventory collection time in seconds
                                  (default: 3600/1 hour)
  --include-costs                 Include cost information
  --include-security-analysis     Include security analysis in inventory
  --include-cost-recommendations  Include cost optimization recommendations
  --parallel                      Enable parallel collection
  --validate                      Enable MCP validation for β‰₯99.5% accuracy
  --validate-all                  Enable comprehensive 3-way validation:
                                  runbooks + MCP + terraform
  --combine                       Combine results from the same AWS account
  --export [csv|markdown|pdf|json|html|xlsx]
                                  Export format(s). Specify multiple times:
                                  --export csv --export markdown
  --output-dir TEXT               Output directory for exports
  --report-name TEXT              Base name for export files (without
                                  extension)
  --dry-run                       Safe analysis mode - no resource
                                  modifications (enterprise default)
  --status [running|stopped]      EC2 instance state filter
  --root-only                     Show only management accounts
  -s, -q, --short                 Brief output mode
  -A, --acct TEXT                 Account ID lookup (can specify multiple)
  --skip-profiles TEXT            Profiles to exclude from collection
  -v, --verbose                   Verbose output with detailed information
  --timing                        Show performance metrics and execution
                                  timing
  --save TEXT                     Output file prefix for saved results
  --filename TEXT                 Custom report filename (overrides --report-
                                  name)
  --config-aggregator             Use Config Aggregator for org-wide discovery
                                  (faster than per-account)
  --aggregator-name TEXT          Config Aggregator name (auto-detected if not
                                  specified)
  --persona [cfo|cto|cloudops|finops|all]
                                  Generate persona-specific report
                                  (cfo|cto|cloudops|finops|all)
  --help                          Show this message and exit.

ExamplesΒΆ