CLI Reference

The mlflow-dynamodbstore CLI provides admin commands for managing your DynamoDB-backed MLflow deployment.

mlflow-dynamodbstore --help

Global Options

Every subcommand inherits:

Option	Description	Required
--name	Stack/table name	Yes
--region	AWS region (e.g. us-east-1)	Yes
--endpoint-url	Custom endpoint (LocalStack/testing)	No

---

Commands

mlflow-dynamodbstore

mlflow-dynamodbstore admin commands.

Usage:

mlflow-dynamodbstore [OPTIONS] COMMAND [ARGS]...

Options:

Name	Type	Description	Default
--name	text	Stack/table name	mlflow
--region	text	AWS region (omit to use boto3 default chain)	None
--endpoint-url	text	Custom endpoint URL (for LocalStack/testing)	None
--help	boolean	Show this message and exit.	False

Subcommands

• deploy: Create the CloudFormation stack and seed initial data.
• destroy: Delete the CloudFormation stack.
• fts: Manage FTS trigram field configuration.
• tag: Manage tag denormalization patterns.
• trace: Trace operations.
• ttl: Manage TTL retention policies.
• workspace: Workspace operations.

mlflow-dynamodbstore deploy

Create the CloudFormation stack and seed initial data.

Usage:

mlflow-dynamodbstore deploy [OPTIONS]

Options:

Name	Type	Description	Default
--help	boolean	Show this message and exit.	False

mlflow-dynamodbstore destroy

Delete the CloudFormation stack.

Usage:

mlflow-dynamodbstore destroy [OPTIONS]

Options:

Name	Type	Description	Default
--yes	boolean	Skip confirmation prompt	False
--retain	boolean	Delete stack but keep the DynamoDB table	False
--help	boolean	Show this message and exit.	False

mlflow-dynamodbstore fts

Manage FTS trigram field configuration.

Usage:

mlflow-dynamodbstore fts [OPTIONS] COMMAND [ARGS]...

Options:

Name	Type	Description	Default
--help	boolean	Show this message and exit.	False

Subcommands

• add: Add a trigram field.
• list: List FTS trigram fields.

mlflow-dynamodbstore fts add

Add a trigram field.

Usage:

mlflow-dynamodbstore fts add [OPTIONS] FIELD

Options:

Name	Type	Description	Default
--help	boolean	Show this message and exit.	False

mlflow-dynamodbstore fts list

List FTS trigram fields.

Usage:

mlflow-dynamodbstore fts list [OPTIONS]

Options:

Name	Type	Description	Default
--help	boolean	Show this message and exit.	False

mlflow-dynamodbstore tag

Manage tag denormalization patterns.

Usage:

mlflow-dynamodbstore tag [OPTIONS] COMMAND [ARGS]...

Options:

Name	Type	Description	Default
--help	boolean	Show this message and exit.	False

Subcommands

• add: Add a denormalization pattern.
• backfill: Backfill denormalized tags onto META items.
• list: List denormalization patterns.
• remove: Remove a denormalization pattern.

mlflow-dynamodbstore tag add

Add a denormalization pattern.

Usage:

mlflow-dynamodbstore tag add [OPTIONS] PATTERN

Options:

Name	Type	Description	Default
--experiment-id	text	Add per-experiment pattern	None
--help	boolean	Show this message and exit.	False

mlflow-dynamodbstore tag backfill

Backfill denormalized tags onto META items.

Scans tag items, matches against configured patterns, and updates META items with denormalized tag attributes.

Usage:

mlflow-dynamodbstore tag backfill [OPTIONS]

Options:

Name	Type	Description	Default
--experiment-id	text	Backfill only this experiment	None
--help	boolean	Show this message and exit.	False

mlflow-dynamodbstore tag list

List denormalization patterns.

Usage:

mlflow-dynamodbstore tag list [OPTIONS]

Options:

Name	Type	Description	Default
--experiment-id	text	Show effective patterns for an experiment	None
--help	boolean	Show this message and exit.	False

mlflow-dynamodbstore tag remove

Remove a denormalization pattern.

Usage:

mlflow-dynamodbstore tag remove [OPTIONS] PATTERN

Options:

Name	Type	Description	Default
--experiment-id	text	Remove per-experiment pattern	None
--help	boolean	Show this message and exit.	False

mlflow-dynamodbstore trace

Trace operations.

Usage:

mlflow-dynamodbstore trace [OPTIONS] COMMAND [ARGS]...

Options:

Name	Type	Description	Default
--help	boolean	Show this message and exit.	False

Subcommands

• cache: Pre-cache X-Ray spans for traces.

mlflow-dynamodbstore trace cache

Pre-cache X-Ray spans for traces.

Usage:

mlflow-dynamodbstore trace cache [OPTIONS]

Options:

Name	Type	Description	Default
--experiment-id	text	Experiment ID(s)	Sentinel.UNSET
--days	integer	Only process traces newer than N days	None
--help	boolean	Show this message and exit.	False

mlflow-dynamodbstore ttl

Manage TTL retention policies.

Usage:

mlflow-dynamodbstore ttl [OPTIONS] COMMAND [ARGS]...

Options:

Name	Type	Description	Default
--help	boolean	Show this message and exit.	False

Subcommands

• cleanup: Find and expire orphaned children of TTL-deleted experiments.
• set: Set TTL policy values.
• show: Show current TTL policy.

mlflow-dynamodbstore ttl cleanup

Find and expire orphaned children of TTL-deleted experiments.

Scans for experiment partitions whose META item has been removed by DynamoDB TTL, then sets ttl = now on all remaining children so DynamoDB will garbage-collect them.

Usage:

mlflow-dynamodbstore ttl cleanup [OPTIONS]

Options:

Name	Type	Description	Default
--dry-run	boolean	Report orphans without setting TTL	False
--help	boolean	Show this message and exit.	False

mlflow-dynamodbstore ttl set

Set TTL policy values.

Usage:

mlflow-dynamodbstore ttl set [OPTIONS]

Options:

Name	Type	Description	Default
--soft-deleted-retention-days	integer	N/A	None
--trace-retention-days	integer	N/A	None
--metric-history-retention-days	integer	N/A	None
--help	boolean	Show this message and exit.	False

mlflow-dynamodbstore ttl show

Show current TTL policy.

Usage:

mlflow-dynamodbstore ttl show [OPTIONS]

Options:

Name	Type	Description	Default
--help	boolean	Show this message and exit.	False

mlflow-dynamodbstore workspace

Workspace operations.

Usage:

mlflow-dynamodbstore workspace [OPTIONS] COMMAND [ARGS]...

Options:

Name	Type	Description	Default
--help	boolean	Show this message and exit.	False

Subcommands

• delete: Delete a workspace.

mlflow-dynamodbstore workspace delete

Delete a workspace.

Usage:

mlflow-dynamodbstore workspace delete [OPTIONS]

Options:

Name	Type	Description	Default
--workspace	text	Workspace name to delete	Sentinel.UNSET
--mode	choice (soft | cascade)	Deletion mode	soft
--yes	boolean	Skip confirmation for cascade	False
--help	boolean	Show this message and exit.	False

---

Examples

Deploy a new stack

mlflow-dynamodbstore --name mlflow --region us-east-1 deploy

Destroy a stack (retain table)

mlflow-dynamodbstore --name mlflow --region us-east-1 destroy --yes --retain

Manage TTL policies

# Show current policy
mlflow-dynamodbstore --name mlflow --region us-east-1 ttl show

# Set retention
mlflow-dynamodbstore --name mlflow --region us-east-1 ttl set \
    --soft-deleted-retention-days 90 \
    --trace-retention-days 30

# Cleanup orphaned items
mlflow-dynamodbstore --name mlflow --region us-east-1 ttl cleanup --dry-run

Manage tag denormalization

mlflow-dynamodbstore --name mlflow --region us-east-1 tag list
mlflow-dynamodbstore --name mlflow --region us-east-1 tag add "mlflow.user"
mlflow-dynamodbstore --name mlflow --region us-east-1 tag backfill

Full-text search configuration

mlflow-dynamodbstore --name mlflow --region us-east-1 fts list
mlflow-dynamodbstore --name mlflow --region us-east-1 fts add "description"

Cache trace spans

mlflow-dynamodbstore --name mlflow --region us-east-1 trace cache \
    --experiment-id 1 --days 7

Delete a workspace

# Soft delete
mlflow-dynamodbstore --name mlflow --region us-east-1 workspace delete \
    --workspace staging --mode soft

# Cascade (with confirmation)
mlflow-dynamodbstore --name mlflow --region us-east-1 workspace delete \
    --workspace staging --mode cascade --yes

Danger

destroy permanently deletes the CloudFormation stack. workspace delete --mode cascade permanently removes all data. These actions cannot be undone.

Tip

Use --retain with destroy to remove the CloudFormation stack while keeping the DynamoDB table and its data intact.