From 98b14c710c4373f1c46c2a652bb5a21a7c7c77be Mon Sep 17 00:00:00 2001 From: Caden <132690522+marofke@users.noreply.github.com> Date: Wed, 27 Mar 2024 18:29:37 -0500 Subject: [PATCH] fix: Update config command help text (#254) Signed-off-by: Caden Marofke --- .../client/cli/_groups/config_group.py | 25 +++++++++++++++---- 1 file changed, 20 insertions(+), 5 deletions(-) diff --git a/src/deadline/client/cli/_groups/config_group.py b/src/deadline/client/cli/_groups/config_group.py index acb836d3..0a68faf1 100644 --- a/src/deadline/client/cli/_groups/config_group.py +++ b/src/deadline/client/cli/_groups/config_group.py @@ -19,32 +19,47 @@ 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. """ @@ -52,7 +67,7 @@ def cli_config(): @_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()