Clarify samconfig.toml header keys

[mousedownmike]

Describe your idea/feature/enhancement

The AWS SAM CLI configuration file documentation does not provide enough information to properly format a samconfig.toml file when a subcommand contains hyphens (-).

The relevant documentation is:

For subcommands, the format of the table header is [environment.command_subcommand.parameters]. For example, for the sam local invoke command, the configuration table header is [default.local_invoke.parameters].

Proposal

Add a section to read:

Hyphenated subcommands must have hyphens converted to underscores. For example, for the sam local start-api command, the configuration table header is [default.local_start_api.parameters].

Additional Details

It's possible that this is something most people know about the TOML format but it is difficult to figure out and remember the conversions between JSON, YAML and TOML. I just spent a few hours figuring out that the parameter-overrides CLI argument needs to be converted to parameter_overrides when placed in the samconfig.toml. It a very difficult visual distinction to make.

[mousedownmike]

Opened in Docs repo