Skip to main content

signaloid-cli buckets list

List all configured AWS S3 buckets.

Synopsis​

signaloid-cli buckets list [options]

Options​

OptionDescription
--cursor <cursor>Resume a listing from the Cursor value of the previous output
--start-key <key>Deprecated, use --cursor. Takes the ContinuationKey of the previous output.
--count <n>Number of items to fetch, across pages. The output's Cursor resumes after the last one.
--limit <n>Items per request, at most 100 (default 25)
--format <type>Output format:json or table (default: json)
--columns <cols>Columns to display (comma-separated) or 'help' to see available columns

Description​

Lists all cloud storage AWS S3 bucket configurations that have been set up for use with Signaloid. Use this command to view your configured S3 buckets and their identifiers.

Examples​

List all buckets:

signaloid-cli buckets list

List the first 20 buckets:

signaloid-cli buckets list --count 20

Resume where a previous output stopped:

signaloid-cli buckets list --cursor <cursor>

Output as a table:

signaloid-cli buckets list --format table

Show available columns:

signaloid-cli buckets list --columns help

Notes​

  • Without --count, the command fetches one page. See Pagination.
  • The bucket ID returned can be used with other bucket commands

See Also​