snow spcs compute-pool suspend¶

Note

You can use Snowpark Container Services from Snowflake CLI only if you have the necessary permissions to use Snowpark Container Services.

Suspends the compute pool by suspending all currently running services and then releasing compute pool nodes.

Syntax¶

snow spcs compute-pool suspend
  <name>
  --connection <connection>
  --account <account>
  --user <user>
  --password <password>
  --authenticator <authenticator>
  --private-key-path <private_key_path>
  --database <database>
  --schema <schema>
  --role <role>
  --warehouse <warehouse>
  --temporary-connection
  --mfa-passcode <mfa_passcode>
  --enable-diag
  --diag-log-path <diag_log_path>
  --diag-allowlist-path <diag_allowlist_path>
  --format <format>
  --verbose
  --debug
  --silent

Copy

Arguments¶

name: Name of the compute pool.

Options¶

--connection, -c, --environment TEXT: Name of the connection, as defined in your config.toml. Default: default.
--account, --accountname TEXT: Name assigned to your Snowflake account. Overrides the value specified for the connection.
--user, --username TEXT: Username to connect to Snowflake. Overrides the value specified for the connection.
--password TEXT: Snowflake password. Overrides the value specified for the connection.
--authenticator TEXT: Snowflake authenticator. Overrides the value specified for the connection.
--private-key-path TEXT: Snowflake private key path. Overrides the value specified for the connection.
--database, --dbname TEXT: Database to use. Overrides the value specified for the connection.
--schema, --schemaname TEXT: Database schema to use. Overrides the value specified for the connection.
--role, --rolename TEXT: Role to use. Overrides the value specified for the connection.
--warehouse TEXT: Warehouse to use. Overrides the value specified for the connection.
--temporary-connection, -x: Uses connection defined with command line parameters, instead of one defined in config.
--mfa-passcode TEXT: Token to use for multi-factor authentication (MFA).
--enable-diag: Run python connector diagnostic test.
--diag-log-path TEXT: Diagnostic report path.
--diag-allowlist-path TEXT: Diagnostic report path to optional allowlist.
--format [TABLE|JSON]: Specifies the output format.
--verbose, -v: Displays log entries for log levels info and higher.
--debug: Displays log entries for log levels debug and higher; debug logs contains additional information.
--silent: Turns off intermediate output to console.

--help: Displays the help text for this command.

Usage notes¶

The current role must have OPERATE privilege on the compute pool to suspend it.

Examples¶

snow spcs compute-pool suspend tutorial_compute_pool

Copy

+-------------------------------------------+
| key    | value                            |
|--------+----------------------------------|
| status | Statement executed successfully. |
+-------------------------------------------+