/snowflake-cloud-admin | Type: Application | PCID required: Yes
Tools
| Tool | Description |
|---|---|
snowflake_cloud_admin_abort_all_queries_on_warehouse | Abort all queries |
snowflake_cloud_admin_create_role | Create a role |
snowflake_cloud_admin_create_user | Create a user |
snowflake_cloud_admin_create_warehouse | Create or replace warehouse |
snowflake_cloud_admin_delete_role | Delete a role |
snowflake_cloud_admin_delete_user | Delete a user |
snowflake_cloud_admin_delete_warehouse | Drop warehouse |
snowflake_cloud_admin_fetch_user | Fetch information about a user |
snowflake_cloud_admin_fetch_warehouse | Describe warehouse |
snowflake_cloud_admin_grant_list_grants | List all grants to the role |
snowflake_cloud_admin_grant_privileges | Grant privileges to the role |
snowflake_cloud_admin_list_roles | List roles |
snowflake_cloud_admin_list_users | List users in the system. |
snowflake_cloud_admin_list_warehouses | List warehouse |
snowflake_cloud_admin_resume_warehouse | Resume warehouse |
snowflake_cloud_admin_role_revoke_grants | Revoke grants from the role |
snowflake_cloud_admin_suspend_warehouse | Suspend warehouse |
snowflake_cloud_admin_abort_all_queries_on_warehouse
Abort all queries Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
ifExists | boolean | No | — | Parameter that specifies how to handle the request for a resource that does not exist: - true: The endpoint does not throw an error if the resource does not exist. It returns a 200 success response, but does not take any action on the resource. - false: The endpoint throws an error if the resource doesn’t exist. |
name | string | Yes | — | Identifier (i.e. name) for the resource. |
snowflake_cloud_admin_create_role
Create a role Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
createMode | string | No | — | Parameter allowing support for different modes of resource creation. Possible values include: - errorIfExists: Throws an error if you try to create a resource that already exists. - orReplace: Automatically replaces the existing resource with the current one. - ifNotExists: Creates a new resource when an alter is requested for a non-existent resource. |
assigned_to_users | integer | No | — | The number of users to whom this role has been assigned. |
comment | string | No | — | Comment of the role. |
created_on | string | No | — | Date and time when the role was created. |
granted_roles | integer | No | — | The number of roles that have been granted to this role. |
granted_to_roles | integer | No | — | The number of roles to which this role has been granted. |
is_current | boolean | No | — | Specifies whether the role being fetched is the user’s current role. |
is_default | boolean | No | — | Specifies whether the role being fetched is the user’s default role. |
is_inherited | boolean | No | — | Specifies whether the role used to run the command inherits the specified role. |
name | string | Yes | — | Name of the role. |
owner | string | No | — | Specifies the role that owns this role. |
snowflake_cloud_admin_create_user
Create a user Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
createMode | string | No | — | Parameter allowing support for different modes of resource creation. Possible values include: - errorIfExists: Throws an error if you try to create a resource that already exists. - orReplace: Automatically replaces the existing resource with the current one. - ifNotExists: Creates a new resource when an alter is requested for a non-existent resource. |
comment | string | No | — | Comment about the user. |
created_on | string | No | — | Created On |
custom_landing_page_url | string | No | — | Custom Landing Page Url |
custom_landing_page_url_flush_next_ui_load | boolean | No | — | Whether or not to flush the custom landing page of the user on next UI load |
days_to_expiry | integer | No | — | How many days until this user expires |
default_namespace | string | No | — | The default namespace to use when this user starts a session |
default_role | string | No | — | The default role to use when this user starts a session |
default_secondary_roles | string | No | — | The default secondary roles of this user to use when starting a session. Only valid set values are ALL or NONE. Default is ALL after 2024-07 BCR. |
default_warehouse | string | No | — | The default warehouse to use when this user starts a session |
disabled | boolean | No | — | Has this user been disabled from the system |
display_name | string | No | — | Display name |
email | string | No | — | Email address |
enable_unredacted_query_syntax_error | boolean | No | — | Whether to show unredacted query syntax errors in the query history. |
expires_at | string | No | — | Expires At |
ext_authn_duo | boolean | No | — | Ext Authn Duo |
ext_authn_uid | string | No | — | Ext Authn Uid |
first_name | string | No | — | First name |
has_password | boolean | No | — | Has Password |
has_rsa_public_key | boolean | No | — | Has Rsa Public Key |
last_name | string | No | — | Last name |
last_successful_login | string | No | — | Last Successful Login |
locked_until | string | No | — | Locked Until |
login_name | string | No | — | Login name |
middle_name | string | No | — | Middle name |
mins_to_bypass_mfa | integer | No | — | How many minutes until MFA is required again |
mins_to_bypass_network_policy | integer | No | — | Temporary bypass network policy on the user for a specified number of minutes |
mins_to_unlock | integer | No | — | How many minutes until the account is unlocked after multiple failed logins |
must_change_password | boolean | No | — | Does this user need to change their password (e.g., after assigning a temp password) |
name | string | Yes | — | User name |
network_policy | string | No | — | Specifies an existing network policy is active for the user. Otherwise, use account default. |
owner | string | No | — | The owner value |
password | string | No | — | The password value |
password_last_set | string | No | — | Password Last Set |
rsa_public_key | string | No | — | RSA public key of the user |
rsa_public_key_2 | string | No | — | Second RSA public key of the user |
rsa_public_key_2_fp | string | No | — | Fingerprint of the user’s second RSA public key |
rsa_public_key_fp | string | No | — | Fingerprint of the user’s RSA public key |
snowflake_lock | boolean | No | — | Whether the user, account, or organization is locked by Snowflake. |
snowflake_support | boolean | No | — | Whether Snowflake Support is allowed to use the user or account |
type | string | No | — | Indicates the type of user (PERSON | SERVICE | LEGACY_SERVICE) |
snowflake_cloud_admin_create_warehouse
Create or replace warehouse Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
createMode | string | No | — | Parameter allowing support for different modes of resource creation. Possible values include: - errorIfExists: Throws an error if you try to create a resource that already exists. - orReplace: Automatically replaces the existing resource with the current one. - ifNotExists: Creates a new resource when an alter is requested for a non-existent resource. |
auto_resume | boolean | No | — | Specifies whether to automatically resume a warehouse when a SQL statement is submitted to it |
auto_suspend | integer | No | — | time in seconds before auto suspend |
available | string | No | — | Percentage of the warehouse compute resources that are provisioned and available. |
budget | string | No | — | Comment representing budget for warehouse. |
comment | string | No | — | Specifies a comment for the warehouse |
created_on | string | No | — | Date and time when the warehouse was created. |
enable_query_acceleration | boolean | No | — | Specifies whether to enable the query acceleration service for queries that rely on this warehouse for compute resources |
initially_suspended | boolean | No | — | Specifies whether the warehouse is created initially in the Suspended state |
is_current | boolean | No | — | Whether the warehouse is in use for the session. Only one warehouse can be in use at a time for a session. To specify or change the warehouse for a session, use the USE WAREHOUSE command. |
is_default | boolean | No | — | Whether the warehouse is the default for the current user. |
kind | string | No | — | The kind value |
max_cluster_count | integer | No | — | Specifies the maximum number of clusters for a multi-cluster warehouse |
max_concurrency_level | integer | No | — | Object parameter that specifies the concurrency level for SQL statements executed by a warehouse cluster |
min_cluster_count | integer | No | — | Specifies the minimum number of clusters for a multi-cluster warehouse |
name | string | Yes | — | A Snowflake object identifier. If the identifier contains spaces or special characters, the entire string must be enclosed in double quotes. Identifiers enclosed in double quotes are also case-sensitive. |
other | string | No | — | Percentage of the warehouse compute resources that are in a state other than available, provisioning, or quiescing. |
owner | string | No | — | Role that owns the warehouse. |
owner_role_type | string | No | — | The type of role that owns the object. |
provisioning | string | No | — | Percentage of the warehouse compute resources that are in the process of provisioning. |
query_acceleration_max_scale_factor | integer | No | — | Specifies the maximum scale factor for leasing compute resources for query acceleration. The scale factor is used as a multiplier based on warehouse size |
queued | integer | No | — | Number of SQL statements that are queued for the warehouse. |
quiescing | string | No | — | Percentage of the warehouse compute resources that are executing SQL statements, but will be shut down once the queries complete. |
resource_monitor | string | No | — | A Snowflake object identifier. If the identifier contains spaces or special characters, the entire string must be enclosed in double quotes. Identifiers enclosed in double quotes are also case-sensitive. |
resumed_on | string | No | — | Date and time when the warehouse was last started or restarted. |
running | integer | No | — | Number of SQL statements that are being executed by the warehouse. |
scaling_policy | string | No | — | Scaling policy of warehouse, possible scaling policies: STANDARD, ECONOMY |
size | string | No | — | [Deprecated] names of size: X-Small, Small, Medium, Large, X-Large, 2X-Large, 3X-Large, 4X-Large, 5X-Large, 6X-Large |
started_clusters | integer | No | — | Number of clusters currently started. |
state | string | No | — | The state of warehouse, possible states: STARTED, STARTING, DYNAMIC, SUSPENDED, RESIZING, RESUMING, SUSPENDING |
statement_queued_timeout_in_seconds | integer | No | — | Object parameter that specifies the time, in seconds, a SQL statement can be queued on a warehouse before it is canceled by the system |
statement_timeout_in_seconds | integer | No | — | Object parameter that specifies the time, in seconds, after which a running SQL statement is canceled by the system |
target_statement_size | string | No | — | Names of size: X-Small, Small, Medium, Large, X-Large, 2X-Large, 3X-Large, 4X-Large, 5X-Large, 6X-Large |
type | string | No | — | [Deprecated] Type of warehouse, possible types: STANDARD, SNOWPARK-OPTIMIZED |
updated_on | string | No | — | Date and time when the warehouse was last updated, which includes changing any of the properties of the warehouse or changing the state (STARTED, SUSPENDED, RESIZING) of the warehouse. |
wait_for_completion | boolean | No | — | When resizing a warehouse, you can use this parameter to block the return of the ALTER WAREHOUSE command until the resize has finished provisioning all its compute resources |
warehouse_credit_limit | integer | No | — | Credit limit that are can be executed by the warehouse. |
warehouse_size | string | No | — | Size of warehouse, possible sizes: XSMALL, SMALL, MEDIUM, LARGE, XLARGE, XXLARGE, XXXLARGE, X4LARGE, X5LARGE, X6LARGE |
warehouse_type | string | No | — | Type of warehouse, possible types: STANDARD, SNOWPARK-OPTIMIZED |
snowflake_cloud_admin_delete_role
Delete a role Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
name | string | Yes | — | Identifier (i.e. name) for the resource. |
ifExists | boolean | No | — | Parameter that specifies how to handle the request for a resource that does not exist: - true: The endpoint does not throw an error if the resource does not exist. It returns a 200 success response, but does not take any action on the resource. - false: The endpoint throws an error if the resource doesn’t exist. |
snowflake_cloud_admin_delete_user
Delete a user Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
name | string | Yes | — | Identifier (i.e. name) for the resource. |
ifExists | boolean | No | — | Parameter that specifies how to handle the request for a resource that does not exist: - true: The endpoint does not throw an error if the resource does not exist. It returns a 200 success response, but does not take any action on the resource. - false: The endpoint throws an error if the resource doesn’t exist. |
snowflake_cloud_admin_delete_warehouse
Drop warehouse Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
ifExists | boolean | No | — | Parameter that specifies how to handle the request for a resource that does not exist: - true: The endpoint does not throw an error if the resource does not exist. It returns a 200 success response, but does not take any action on the resource. - false: The endpoint throws an error if the resource doesn’t exist. |
name | string | Yes | — | Identifier (i.e. name) for the resource. |
snowflake_cloud_admin_fetch_user
Fetch information about a user Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
name | string | Yes | — | Identifier (i.e. name) for the resource. |
snowflake_cloud_admin_fetch_warehouse
Describe warehouse Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
name | string | Yes | — | Identifier (i.e. name) for the resource. |
snowflake_cloud_admin_grant_list_grants
List all grants to the role Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
name | string | Yes | — | Identifier (i.e. name) for the resource. |
showLimit | integer | No | — | Parameter to limit the maximum number of rows returned by a command. |
snowflake_cloud_admin_grant_privileges
Grant privileges to the role Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
name | string | Yes | — | Identifier (i.e. name) for the resource. |
containing_scope | object | No | — | Containing Scope |
created_on | string | No | — | Date and time when the grant was created |
granted_by | string | No | — | The role that granted this privilege to this grantee |
privileges | string[] | No | — | List of privileges to be granted. |
securable | object | No | — | The securable value |
securable_type | string | Yes | — | Type of the securable to be granted. Only ROLE is supported |
snowflake_cloud_admin_list_roles
List roles Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
like | string | No | — | Parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters. |
startsWith | string | No | — | Parameter to filter the command output based on the string of characters that appear at the beginning of the object name. Uses case-sensitive pattern matching. |
showLimit | integer | No | — | Parameter to limit the maximum number of rows returned by a command. |
fromName | string | No | — | Parameter to enable fetching rows only following the first row whose object name matches the specified string. Case-sensitive and does not have to be the full name. |
snowflake_cloud_admin_list_users
List users in the system. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
like | string | No | — | Parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters. |
startsWith | string | No | — | Parameter to filter the command output based on the string of characters that appear at the beginning of the object name. Uses case-sensitive pattern matching. |
showLimit | integer | No | — | Parameter to limit the maximum number of rows returned by a command. |
fromName | string | No | — | Parameter to enable fetching rows only following the first row whose object name matches the specified string. Case-sensitive and does not have to be the full name. |
snowflake_cloud_admin_list_warehouses
List warehouse Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
like | string | No | — | Parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters. |
snowflake_cloud_admin_resume_warehouse
Resume warehouse Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
ifExists | boolean | No | — | Parameter that specifies how to handle the request for a resource that does not exist: - true: The endpoint does not throw an error if the resource does not exist. It returns a 200 success response, but does not take any action on the resource. - false: The endpoint throws an error if the resource doesn’t exist. |
name | string | Yes | — | Identifier (i.e. name) for the resource. |
snowflake_cloud_admin_role_revoke_grants
Revoke grants from the role Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
name | string | Yes | — | Identifier (i.e. name) for the resource. |
mode | string | No | — | Parameter determines whether the revoke operation succeeds or fails for the privileges, based on the whether the privileges had been re-granted to another role. - restrict: If the privilege being revoked has been re-granted to another role, the REVOKE command fails. - cascade: If the privilege being revoked has been re-granted, the REVOKE command recursively revokes these dependent grants. If the same privilege on an object has been granted to the target role by a different grantor (parallel grant), that grant is not affected and the target role retains the privilege. |
containing_scope | object | No | — | Containing Scope |
created_on | string | No | — | Date and time when the grant was created |
granted_by | string | No | — | The role that granted this privilege to this grantee |
privileges | string[] | No | — | List of privileges to be granted. |
securable | object | No | — | The securable value |
securable_type | string | Yes | — | Type of the securable to be granted. Only ROLE is supported |
snowflake_cloud_admin_suspend_warehouse
Suspend warehouse Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
ifExists | boolean | No | — | Parameter that specifies how to handle the request for a resource that does not exist: - true: The endpoint does not throw an error if the resource does not exist. It returns a 200 success response, but does not take any action on the resource. - false: The endpoint throws an error if the resource doesn’t exist. |
name | string | Yes | — | Identifier (i.e. name) for the resource. |

