Skip to main content
Server path: /snowflake-cloud-admin | Type: Application | PCID required: Yes

Tools


snowflake_cloud_admin_abort_all_queries_on_warehouse

Abort all queries Parameters:
ParameterTypeRequiredDefaultDescription
ifExistsbooleanNoParameter 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.
namestringYesIdentifier (i.e. name) for the resource.

snowflake_cloud_admin_create_role

Create a role Parameters:
ParameterTypeRequiredDefaultDescription
createModestringNoParameter 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_usersintegerNoThe number of users to whom this role has been assigned.
commentstringNoComment of the role.
created_onstringNoDate and time when the role was created.
granted_rolesintegerNoThe number of roles that have been granted to this role.
granted_to_rolesintegerNoThe number of roles to which this role has been granted.
is_currentbooleanNoSpecifies whether the role being fetched is the user’s current role.
is_defaultbooleanNoSpecifies whether the role being fetched is the user’s default role.
is_inheritedbooleanNoSpecifies whether the role used to run the command inherits the specified role.
namestringYesName of the role.
ownerstringNoSpecifies the role that owns this role.

snowflake_cloud_admin_create_user

Create a user Parameters:
ParameterTypeRequiredDefaultDescription
createModestringNoParameter 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.
commentstringNoComment about the user.
created_onstringNoCreated On
custom_landing_page_urlstringNoCustom Landing Page Url
custom_landing_page_url_flush_next_ui_loadbooleanNoWhether or not to flush the custom landing page of the user on next UI load
days_to_expiryintegerNoHow many days until this user expires
default_namespacestringNoThe default namespace to use when this user starts a session
default_rolestringNoThe default role to use when this user starts a session
default_secondary_rolesstringNoThe 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_warehousestringNoThe default warehouse to use when this user starts a session
disabledbooleanNoHas this user been disabled from the system
display_namestringNoDisplay name
emailstringNoEmail address
enable_unredacted_query_syntax_errorbooleanNoWhether to show unredacted query syntax errors in the query history.
expires_atstringNoExpires At
ext_authn_duobooleanNoExt Authn Duo
ext_authn_uidstringNoExt Authn Uid
first_namestringNoFirst name
has_passwordbooleanNoHas Password
has_rsa_public_keybooleanNoHas Rsa Public Key
last_namestringNoLast name
last_successful_loginstringNoLast Successful Login
locked_untilstringNoLocked Until
login_namestringNoLogin name
middle_namestringNoMiddle name
mins_to_bypass_mfaintegerNoHow many minutes until MFA is required again
mins_to_bypass_network_policyintegerNoTemporary bypass network policy on the user for a specified number of minutes
mins_to_unlockintegerNoHow many minutes until the account is unlocked after multiple failed logins
must_change_passwordbooleanNoDoes this user need to change their password (e.g., after assigning a temp password)
namestringYesUser name
network_policystringNoSpecifies an existing network policy is active for the user. Otherwise, use account default.
ownerstringNoThe owner value
passwordstringNoThe password value
password_last_setstringNoPassword Last Set
rsa_public_keystringNoRSA public key of the user
rsa_public_key_2stringNoSecond RSA public key of the user
rsa_public_key_2_fpstringNoFingerprint of the user’s second RSA public key
rsa_public_key_fpstringNoFingerprint of the user’s RSA public key
snowflake_lockbooleanNoWhether the user, account, or organization is locked by Snowflake.
snowflake_supportbooleanNoWhether Snowflake Support is allowed to use the user or account
typestringNoIndicates the type of user (PERSON | SERVICE | LEGACY_SERVICE)

snowflake_cloud_admin_create_warehouse

Create or replace warehouse Parameters:
ParameterTypeRequiredDefaultDescription
createModestringNoParameter 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_resumebooleanNoSpecifies whether to automatically resume a warehouse when a SQL statement is submitted to it
auto_suspendintegerNotime in seconds before auto suspend
availablestringNoPercentage of the warehouse compute resources that are provisioned and available.
budgetstringNoComment representing budget for warehouse.
commentstringNoSpecifies a comment for the warehouse
created_onstringNoDate and time when the warehouse was created.
enable_query_accelerationbooleanNoSpecifies whether to enable the query acceleration service for queries that rely on this warehouse for compute resources
initially_suspendedbooleanNoSpecifies whether the warehouse is created initially in the Suspended state
is_currentbooleanNoWhether 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_defaultbooleanNoWhether the warehouse is the default for the current user.
kindstringNoThe kind value
max_cluster_countintegerNoSpecifies the maximum number of clusters for a multi-cluster warehouse
max_concurrency_levelintegerNoObject parameter that specifies the concurrency level for SQL statements executed by a warehouse cluster
min_cluster_countintegerNoSpecifies the minimum number of clusters for a multi-cluster warehouse
namestringYesA 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.
otherstringNoPercentage of the warehouse compute resources that are in a state other than available, provisioning, or quiescing.
ownerstringNoRole that owns the warehouse.
owner_role_typestringNoThe type of role that owns the object.
provisioningstringNoPercentage of the warehouse compute resources that are in the process of provisioning.
query_acceleration_max_scale_factorintegerNoSpecifies the maximum scale factor for leasing compute resources for query acceleration. The scale factor is used as a multiplier based on warehouse size
queuedintegerNoNumber of SQL statements that are queued for the warehouse.
quiescingstringNoPercentage of the warehouse compute resources that are executing SQL statements, but will be shut down once the queries complete.
resource_monitorstringNoA 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_onstringNoDate and time when the warehouse was last started or restarted.
runningintegerNoNumber of SQL statements that are being executed by the warehouse.
scaling_policystringNoScaling policy of warehouse, possible scaling policies: STANDARD, ECONOMY
sizestringNo[Deprecated] names of size: X-Small, Small, Medium, Large, X-Large, 2X-Large, 3X-Large, 4X-Large, 5X-Large, 6X-Large
started_clustersintegerNoNumber of clusters currently started.
statestringNoThe state of warehouse, possible states: STARTED, STARTING, DYNAMIC, SUSPENDED, RESIZING, RESUMING, SUSPENDING
statement_queued_timeout_in_secondsintegerNoObject 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_secondsintegerNoObject parameter that specifies the time, in seconds, after which a running SQL statement is canceled by the system
target_statement_sizestringNoNames of size: X-Small, Small, Medium, Large, X-Large, 2X-Large, 3X-Large, 4X-Large, 5X-Large, 6X-Large
typestringNo[Deprecated] Type of warehouse, possible types: STANDARD, SNOWPARK-OPTIMIZED
updated_onstringNoDate 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_completionbooleanNoWhen 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_limitintegerNoCredit limit that are can be executed by the warehouse.
warehouse_sizestringNoSize of warehouse, possible sizes: XSMALL, SMALL, MEDIUM, LARGE, XLARGE, XXLARGE, XXXLARGE, X4LARGE, X5LARGE, X6LARGE
warehouse_typestringNoType of warehouse, possible types: STANDARD, SNOWPARK-OPTIMIZED

snowflake_cloud_admin_delete_role

Delete a role Parameters:
ParameterTypeRequiredDefaultDescription
namestringYesIdentifier (i.e. name) for the resource.
ifExistsbooleanNoParameter 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:
ParameterTypeRequiredDefaultDescription
namestringYesIdentifier (i.e. name) for the resource.
ifExistsbooleanNoParameter 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:
ParameterTypeRequiredDefaultDescription
ifExistsbooleanNoParameter 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.
namestringYesIdentifier (i.e. name) for the resource.

snowflake_cloud_admin_fetch_user

Fetch information about a user Parameters:
ParameterTypeRequiredDefaultDescription
namestringYesIdentifier (i.e. name) for the resource.

snowflake_cloud_admin_fetch_warehouse

Describe warehouse Parameters:
ParameterTypeRequiredDefaultDescription
namestringYesIdentifier (i.e. name) for the resource.

snowflake_cloud_admin_grant_list_grants

List all grants to the role Parameters:
ParameterTypeRequiredDefaultDescription
namestringYesIdentifier (i.e. name) for the resource.
showLimitintegerNoParameter to limit the maximum number of rows returned by a command.

snowflake_cloud_admin_grant_privileges

Grant privileges to the role Parameters:
ParameterTypeRequiredDefaultDescription
namestringYesIdentifier (i.e. name) for the resource.
containing_scopeobjectNoContaining Scope
created_onstringNoDate and time when the grant was created
granted_bystringNoThe role that granted this privilege to this grantee
privilegesstring[]NoList of privileges to be granted.
securableobjectNoThe securable value
securable_typestringYesType of the securable to be granted. Only ROLE is supported

snowflake_cloud_admin_list_roles

List roles Parameters:
ParameterTypeRequiredDefaultDescription
likestringNoParameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters.
startsWithstringNoParameter 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.
showLimitintegerNoParameter to limit the maximum number of rows returned by a command.
fromNamestringNoParameter 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:
ParameterTypeRequiredDefaultDescription
likestringNoParameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters.
startsWithstringNoParameter 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.
showLimitintegerNoParameter to limit the maximum number of rows returned by a command.
fromNamestringNoParameter 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:
ParameterTypeRequiredDefaultDescription
likestringNoParameter 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:
ParameterTypeRequiredDefaultDescription
ifExistsbooleanNoParameter 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.
namestringYesIdentifier (i.e. name) for the resource.

snowflake_cloud_admin_role_revoke_grants

Revoke grants from the role Parameters:
ParameterTypeRequiredDefaultDescription
namestringYesIdentifier (i.e. name) for the resource.
modestringNoParameter 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_scopeobjectNoContaining Scope
created_onstringNoDate and time when the grant was created
granted_bystringNoThe role that granted this privilege to this grantee
privilegesstring[]NoList of privileges to be granted.
securableobjectNoThe securable value
securable_typestringYesType of the securable to be granted. Only ROLE is supported

snowflake_cloud_admin_suspend_warehouse

Suspend warehouse Parameters:
ParameterTypeRequiredDefaultDescription
ifExistsbooleanNoParameter 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.
namestringYesIdentifier (i.e. name) for the resource.