mc inventory status

The mc inventory status command displays the execution status of an inventory job.

The command shows comprehensive information about the job’s current state, progress, and execution history. You can optionally watch the status in real-time as the job progresses.

Syntax

Example Syntax

The command has the following syntax:

mc [GLOBALFLAGS] inventory status  \
                       [--watch]    \
                       TARGET/BUCKET \
                       ID

Brackets [] indicate optional parameters.
Parameters sharing a line are mutually dependent.
Parameters separated using the pipe | operator are mutually exclusive.

Copy the example to a text editor and modify as-needed before running the command in the terminal/shell.

Parameters

TARGET/BUCKET

Required

The full path to the bucket containing the inventory configuration. Specify both the alias and bucket name in the format ALIAS/BUCKET.

For example:

mc inventory status myaistor/mybucket my-inventory-id

ID

Required

The unique identifier of the inventory configuration for which to display status.

For example:

mc inventory status myaistor/mybucket monthly-report

--watch

Alias: -w

Optional

Watch the inventory job status and display real-time updates as the job progresses.

The status refreshes approximately every 2 seconds and displays a spinner animation during execution. Press Ctrl+C to stop watching and exit.

For example:

mc inventory status --watch myaistor/mybucket myjob-id

Global flags

This command supports any of the global flags.

Examples

Display job status

The following command displays the current status of an inventory job:

mc inventory status myaistor/mybucket weekly-inventory

Replace myaistor with the alias of your AIStor deployment.
Replace mybucket with the name of the bucket.
Replace weekly-inventory with the inventory configuration ID.

S3 compatibility

The mc commandline tool is built for compatibility with the AWS S3 API and is tested with AIStor and AWS S3 for expected functionality and behavior.

MinIO provides no guarantees for other S3-compatible services, as their S3 API implementation is unknown and therefore unsupported.

While mc commands may work as documented, any such usage is at your own risk.

Permissions

The user or service account running this command must have the s3:GetInventoryConfiguration permission for the specified bucket.

For more information on AIStor policies and permissions, see Access Management.

Behavior

Status information

The command displays comprehensive status information including:

JobID: The inventory configuration identifier
State: Current job state
Bucket: The source bucket being inventoried
User: The user or service account that created the configuration
Access Key: The access key used for execution
Schedule: The job schedule (once, hourly, daily, weekly, monthly, yearly)
Scanned Objects: Total size of objects scanned
Scanned Count: Total number of objects scanned
Matched Objects: Size of objects matching filters
Matched Count: Number of objects matching filters
Records Written: Number of records written to output files
Output Files: Number of output files generated
Execution Time: Duration of the current or last execution
Num Starts: Total number of times the job has executed
Manifest Path: Location of the manifest file for the current or last execution
Start Time: When the current or last execution started
End Time: When the last execution completed
Next Scheduled Time: When the job is scheduled to run next (periodic jobs only)
Last Fail Time: When the job last failed (if applicable)