Skip to content

Commit

Permalink
fix: Update config command help text (#254)
Browse files Browse the repository at this point in the history
Signed-off-by: Caden Marofke <marofke@amazon.com>
  • Loading branch information
marofke committed Mar 27, 2024
1 parent 6a6b114 commit 98b14c7
Showing 1 changed file with 20 additions and 5 deletions.
25 changes: 20 additions & 5 deletions src/deadline/client/cli/_groups/config_group.py
Original file line number Diff line number Diff line change
Expand Up @@ -19,40 +19,55 @@ def cli_config():
The available AWS Deadline Cloud settings are:
defaults.aws_profile_name:
The default AWS profile to use for AWS Deadline Cloud commands.
The default AWS profile to use for AWS Deadline Cloud commands. Set to '' to use the default credentials. Other settings are saved with the profile.
defaults.farm_id:
The default farm ID to use for job submissions or CLI operations.
defaults.queue_id:
The default queue ID to use for job submissions or CLI operations.
settings.storage_profile_id:
The storage profile that this workstation conforms to. It specifies
where shared file systems are mounted, and where named job attachments
should go.
defaults.job_id:
The Job ID to use by default. This gets updated by job submission so is normally the most recently submitted job.
settings.job_history_dir:
The directory in which to create new job bundles for
submitting to AWS Deadline Cloud, to produce a history of job submissions.
The directory in which to create new job bundles for submitting to AWS Deadline Cloud, to produce a history of job submissions.
settings.auto_accept:
Flag to automatically confirm any confirmation prompts
Flag to automatically confirm any confirmation prompts.
settings.log_level:
Setting to change the log level. Must be one of ["ERROR", "WARNING", "INFO", "DEBUG"]
defaults.job_attachments_file_system:
Setting to determine if attachments are copied on to workers before a job executes
or fetched in realtime. Must be one of ["COPIED", "VIRTUAL"]
telemetry.opt_out:
Flag to specify opting out of telemetry data collection.
"""


@cli_config.command(name="show")
@_handle_error
def config_show():
"""
Show AWS Deadline Cloud's current workstation configuration settings.
Show AWS Deadline Cloud's current workstation configuration.
"""
click.echo(f"AWS Deadline Cloud configuration file:\n {config_file.get_config_file_path()}")
click.echo()
Expand Down

0 comments on commit 98b14c7

Please sign in to comment.