DOCUMENTATION
/
Get started
Guides
Developer
Reference
Release notes
Tutorials
Status
  1. Overview
    • SQL data types reference
    • SQL command reference
    • Function and stored procedure reference
        1. Summary of functions
          • All functions (alphabetical)
            • Aggregate
            • AISQL
              1. Scalar functions
                1. AI_CLASSIFY
                  • AI_COMPLETE
                  • AI_EMBED
                    • AI_EXTRACT
                      • AI_FILTER
                        • AI_PARSE_DOCUMENT
                          • AI_SENTIMENT
                            • AI_SIMILARITY
                              • AI_TRANSCRIBE
                                • CLASSIFY_TEXT (SNOWFLAKE.CORTEX)
                                  • COMPLETE (SNOWFLAKE.CORTEX)
                                    • COMPLETE multimodal (images) (SNOWFLAKE.CORTEX)
                                      • EMBED_TEXT_768 (SNOWFLAKE.CORTEX)
                                        • EMBED_TEXT_1024 (SNOWFLAKE.CORTEX)
                                          • ENTITY_SENTIMENT (SNOWFLAKE.CORTEX)
                                            • EXTRACT_ANSWER (SNOWFLAKE.CORTEX)
                                              • FINETUNE (SNOWFLAKE.CORTEX)
                                              • PARSE_DOCUMENT (SNOWFLAKE.CORTEX)
                                                • SENTIMENT (SNOWFLAKE.CORTEX)
                                                  • SUMMARIZE (SNOWFLAKE.CORTEX)
                                                    • TRANSLATE (SNOWFLAKE.CORTEX)
                                                    • Aggregate functions
                                                      1. AI_AGG
                                                        • AI_SUMMARIZE_AGG
                                                        • Helper functions
                                                          1. COUNT_TOKENS (SNOWFLAKE.CORTEX)
                                                            • SEARCH_PREVIEW (SNOWFLAKE.CORTEX)
                                                              • SPLIT_TEXT_MARKDOWN_HEADER (SNOWFLAKE.CORTEX)
                                                                • SPLIT_TEXT_RECURSIVE_CHARACTER (SNOWFLAKE.CORTEX)
                                                                  • TRY_COMPLETE (SNOWFLAKE.CORTEX)
                                                                • Bitwise expression
                                                                • Conditional expression
                                                                • Context
                                                                • Conversion
                                                                • Data generation
                                                                • Data metric
                                                                • Date & time
                                                                • Differential privacy
                                                                • Encryption
                                                                • File
                                                                • Geospatial
                                                                • Hash
                                                                • Metadata
                                                                • ML Model Monitors
                                                                • Notification
                                                                • Numeric
                                                                • Organization users and organization user groups
                                                                • Regular expressions
                                                                • Semi-structured and structured data
                                                                • Snowpark Container Services
                                                                • String & binary
                                                                • System
                                                                    1. Control
                                                                    2. SYSTEM$ABORT_SESSION
                                                                      • SYSTEM$ABORT_TRANSACTION
                                                                        • SYSTEM$ACTIVATE_CMK_INFO
                                                                          • SYSTEM$ADD_EVENT
                                                                            • SYSTEM$ADD_REFERENCE
                                                                              • SYSTEM$AUTHORIZE_PRIVATELINK
                                                                                • SYSTEM$AUTHORIZE_STAGE_PRIVATELINK_ACCESS
                                                                                  • SYSTEM$BEGIN_DEBUG_APPLICATION
                                                                                    • SYSTEM$BLOCK_INTERNAL_STAGES_PUBLIC_ACCESS
                                                                                      • SYSTEM$CANCEL_ALL_QUERIES
                                                                                        • SYSTEM$CANCEL_QUERY
                                                                                          • SYSTEM$CLEANUP_DATABASE_ROLE_GRANTS
                                                                                            • SYSTEM$COMMIT_MOVE_ORGANIZATION_ACCOUNT
                                                                                              • SYSTEM$CONVERT_PIPES_SQS_TO_SNS
                                                                                                • SYSTEM$CREATE_BILLING_EVENT
                                                                                                  • SYSTEM$CREATE_BILLING_EVENTS
                                                                                                    • SYSTEM$DEACTIVATE_CMK_INFO
                                                                                                      • SYSTEM$DEPROVISION_PRIVATELINK_ENDPOINT
                                                                                                        • SYSTEM$DEREGISTER_CMK_INFO
                                                                                                          • SYSTEM$DISABLE_BEHAVIOR_CHANGE_BUNDLE
                                                                                                            • SYSTEM$DISABLE_DATABASE_REPLICATION
                                                                                                              • SYSTEM$DISABLE_GLOBAL_DATA_SHARING_FOR_ACCOUNT
                                                                                                                • SYSTEM$DISABLE_PREVIEW_ACCESS
                                                                                                                  • SYSTEM$DISABLE_PRIVATELINK_ACCESS_ONLY
                                                                                                                    • SYSTEM$ENABLE_BEHAVIOR_CHANGE_BUNDLE
                                                                                                                      • SYSTEM$ENABLE_GLOBAL_DATA_SHARING_FOR_ACCOUNT
                                                                                                                        • SYSTEM$ENABLE_PREVIEW_ACCESS
                                                                                                                          • SYSTEM$END_DEBUG_APPLICATION
                                                                                                                            • SYSTEM$ENFORCE_PRIVATELINK_ACCESS_ONLY
                                                                                                                              • SYSTEM$FINISH_OAUTH_FLOW
                                                                                                                                • SYSTEM$GLOBAL_ACCOUNT_SET_PARAMETER
                                                                                                                                  • SYSTEM$INITIATE_MOVE_ORGANIZATION_ACCOUNT
                                                                                                                                    • SYSTEM$LINK_ACCOUNT_OBJECTS_BY_NAME
                                                                                                                                      • SYSTEM$LINK_ORGANIZATION_USER
                                                                                                                                        • SYSTEM$LINK_ORGANIZATION_USER_GROUP
                                                                                                                                          • SYSTEM$MIGRATE_SAML_IDP_REGISTRATION
                                                                                                                                            • SYSTEM$OPT_IN_INTERNAL_STAGE_NETWORK_ACCESS_LOGS
                                                                                                                                              • SYSTEM$OPT_OUT_INTERNAL_STAGE_NETWORK_ACCESS_LOGS
                                                                                                                                                • SYSTEM$PIPE_FORCE_RESUME
                                                                                                                                                  • SYSTEM$PIPE_REBINDING_WITH_NOTIFICATION_CHANNEL
                                                                                                                                                    • SYSTEM$PROVISION_PRIVATELINK_ENDPOINT
                                                                                                                                                      • SYSTEM$REGISTER_CMK_INFO
                                                                                                                                                        • SYSTEM$REGISTER_PRIVATELINK_ENDPOINT
                                                                                                                                                          • SYSTEM$REMOVE_ALL_REFERENCES
                                                                                                                                                            • SYSTEM$REMOVE_REFERENCE
                                                                                                                                                              • SYSTEM$RESTORE_PRIVATELINK_ENDPOINT
                                                                                                                                                                • SYSTEM$REVOKE_PRIVATELINK
                                                                                                                                                                  • SYSTEM$REVOKE_STAGE_PRIVATELINK_ACCESS
                                                                                                                                                                    • SYSTEM$SCHEDULE_ASYNC_REPLICATION_GROUP_REFRESH
                                                                                                                                                                      • SYSTEM$SEND_NOTIFICATIONS_TO_CATALOG
                                                                                                                                                                        • SYSTEM$SET_APPLICATION_RESTRICTED_FEATURE_ACCESS
                                                                                                                                                                          • SYSTEM$SET_EVENT_SHARING_ACCOUNT_FOR_REGION
                                                                                                                                                                            • SYSTEM$SET_PRIVATELINK_ENDPOINT_HOSTNAME
                                                                                                                                                                              • SYSTEM$SET_REFERENCE
                                                                                                                                                                                • SYSTEM$SNOWPIPE_STREAMING_UPDATE_CHANNEL_OFFSET_TOKEN
                                                                                                                                                                                  • SYSTEM$START_OAUTH_FLOW
                                                                                                                                                                                    • SYSTEM$START_USER_EMAIL_VERIFICATION
                                                                                                                                                                                      • SYSTEM$TASK_DEPENDENTS_ENABLE
                                                                                                                                                                                        • SYSTEM$TRIGGER_LISTING_REFRESH
                                                                                                                                                                                          • SYSTEM$UNBLOCK_INTERNAL_STAGES_PUBLIC_ACCESS
                                                                                                                                                                                            • SYSTEM$UNLINK_ORGANIZATION_USER
                                                                                                                                                                                              • SYSTEM$UNLINK_ORGANIZATION_USER_GROUP
                                                                                                                                                                                                • SYSTEM$UNREGISTER_PRIVATELINK_ENDPOINT
                                                                                                                                                                                                  • SYSTEM$UNSET_EVENT_SHARING_ACCOUNT_FOR_REGION
                                                                                                                                                                                                    • SYSTEM$USER_TASK_CANCEL_ONGOING_EXECUTIONS
                                                                                                                                                                                                      • SYSTEM$WAIT
                                                                                                                                                                                                        • Information
                                                                                                                                                                                                        • EXTRACT_SEMANTIC_CATEGORIES
                                                                                                                                                                                                          • GET_ANACONDA_PACKAGES_REPODATA
                                                                                                                                                                                                            • SHOW_PYTHON_PACKAGES_DEPENDENCIES
                                                                                                                                                                                                              • SYSTEM$ALLOWLIST
                                                                                                                                                                                                                • SYSTEM$ALLOWLIST_PRIVATELINK
                                                                                                                                                                                                                  • SYSTEM$APP_COMPATIBILITY_CHECK
                                                                                                                                                                                                                    • SYSTEM$APPLICATION_GET_LOG_LEVEL
                                                                                                                                                                                                                      • SYSTEM$APPLICATION_GET_METRIC_LEVEL
                                                                                                                                                                                                                        • SYSTEM$APPLICATION_GET_TRACE_LEVEL
                                                                                                                                                                                                                          • SYSTEM$AUTO_REFRESH_STATUS
                                                                                                                                                                                                                            • SYSTEM$BEHAVIOR_CHANGE_BUNDLE_STATUS
                                                                                                                                                                                                                              • SYSTEM$CATALOG_LINK_STATUS
                                                                                                                                                                                                                                • SYSTEM$CLIENT_VERSION_INFO
                                                                                                                                                                                                                                  • SYSTEM$CLIENT_VULNERABILITY_INFO
                                                                                                                                                                                                                                    • SYSTEM$CLUSTERING_DEPTH
                                                                                                                                                                                                                                      • SYSTEM$CLUSTERING_INFORMATION
                                                                                                                                                                                                                                        • SYSTEM$CLUSTERING_RATIO
                                                                                                                                                                                                                                          • SYSTEM$CURRENT_USER_TASK_NAME
                                                                                                                                                                                                                                            • SYSTEM$DATA_METRIC_SCAN
                                                                                                                                                                                                                                              • SYSTEM$DATABASE_REFRESH_HISTORY
                                                                                                                                                                                                                                                • SYSTEM$DATABASE_REFRESH_PROGRESS
                                                                                                                                                                                                                                                  • SYSTEM$DATABASE_REFRESH_PROGRESS_BY_JOB
                                                                                                                                                                                                                                                    • SYSTEM$DECODE_PAT
                                                                                                                                                                                                                                                      • SYSTEM$ESTIMATE_AUTOMATIC_CLUSTERING_COSTS
                                                                                                                                                                                                                                                        • SYSTEM$ESTIMATE_SEARCH_OPTIMIZATION_COSTS
                                                                                                                                                                                                                                                          • SYSTEM$EVALUATE_DATA_METRIC_EXPECTATIONS
                                                                                                                                                                                                                                                            • SYSTEM$EXTERNAL_TABLE_PIPE_STATUS
                                                                                                                                                                                                                                                              • SYSTEM$GENERATE_SAML_CSR
                                                                                                                                                                                                                                                                • SYSTEM$GENERATE_SCIM_ACCESS_TOKEN
                                                                                                                                                                                                                                                                  • SYSTEM$GET_AWS_SNS_IAM_POLICY
                                                                                                                                                                                                                                                                    • SYSTEM$GET_ALL_REFERENCES
                                                                                                                                                                                                                                                                      • SYSTEM$GET_CLASSIFICATION_RESULT
                                                                                                                                                                                                                                                                        • SYSTEM$GET_CMK_AKV_CONSENT_URL
                                                                                                                                                                                                                                                                          • SYSTEM$GET_CMK_CONFIG
                                                                                                                                                                                                                                                                            • SYSTEM$GET_CMK_INFO
                                                                                                                                                                                                                                                                              • SYSTEM$GET_CMK_KMS_KEY_POLICY
                                                                                                                                                                                                                                                                                • SYSTEM$GET_COMPUTE_POOL_PENDING_MAINTENANCE
                                                                                                                                                                                                                                                                                  • SYSTEM$GET_DEBUG_STATUS
                                                                                                                                                                                                                                                                                    • SYSTEM$GET_DIRECTORY_TABLE_STATUS
                                                                                                                                                                                                                                                                                      • SYSTEM$GET_GCP_KMS_CMK_GRANT_ACCESS_CMD
                                                                                                                                                                                                                                                                                        • SYSTEM$GET_HASH_FOR_APP
                                                                                                                                                                                                                                                                                          • SYSTEM$GET_ICEBERG_TABLE_INFORMATION
                                                                                                                                                                                                                                                                                            • SYSTEM$GET_LOGIN_FAILURE_DETAILS
                                                                                                                                                                                                                                                                                              • SYSTEM$GET_PREDECESSOR_RETURN_VALUE
                                                                                                                                                                                                                                                                                                • SYSTEM$GET_PREVIEW_ACCESS_STATUS
                                                                                                                                                                                                                                                                                                  • SYSTEM$GET_PRIVATELINK
                                                                                                                                                                                                                                                                                                    • SYSTEM$GET_PRIVATELINK_AUTHORIZED_ENDPOINTS
                                                                                                                                                                                                                                                                                                      • SYSTEM$GET_PRIVATELINK_CONFIG
                                                                                                                                                                                                                                                                                                        • SYSTEM$GET_PRIVATELINK_ENDPOINTS_INFO
                                                                                                                                                                                                                                                                                                          • SYSTEM$GET_PRIVATELINK_ENDPOINT_REGISTRATIONS
                                                                                                                                                                                                                                                                                                            • SYSTEM$GET_REFERENCED_OBJECT_ID_HASH
                                                                                                                                                                                                                                                                                                              • SYSTEM$GET_SERVICE_DNS_DOMAIN
                                                                                                                                                                                                                                                                                                                • SYSTEM$GET_SERVICE_LOGS
                                                                                                                                                                                                                                                                                                                  • SYSTEM$GET_SERVICE_STATUS
                                                                                                                                                                                                                                                                                                                    • SYSTEM$GET_SNOWFLAKE_PLATFORM_INFO
                                                                                                                                                                                                                                                                                                                      • SYSTEM$GET_TAG
                                                                                                                                                                                                                                                                                                                        • SYSTEM$GET_TAG_ALLOWED_VALUES
                                                                                                                                                                                                                                                                                                                          • SYSTEM$GET_TAG_ON_CURRENT_COLUMN
                                                                                                                                                                                                                                                                                                                            • SYSTEM$GET_TAG_ON_CURRENT_TABLE
                                                                                                                                                                                                                                                                                                                              • SYSTEM$GET_TASK_GRAPH_CONFIG
                                                                                                                                                                                                                                                                                                                                • SYSTEM$HOLD_PRIVILEGE_ON_ACCOUNT
                                                                                                                                                                                                                                                                                                                                  • SYSTEM$INTERNAL_STAGES_PUBLIC_ACCESS_STATUS
                                                                                                                                                                                                                                                                                                                                    • SYSTEM$IS_APPLICATION_INSTALLED_FROM_SAME_ACCOUNT
                                                                                                                                                                                                                                                                                                                                      • SYSTEM$IS_APPLICATION_ALL_MANDATORY_TELEMETRY_EVENT_DEFINITIONS_ENABLED
                                                                                                                                                                                                                                                                                                                                        • SYSTEM$IS_APPLICATION_ALL_MANDATORY_TELEMETRY_EVENT_DEFINITIONS_ENABLED
                                                                                                                                                                                                                                                                                                                                          • SYSTEM$IS_APPLICATION_SHARING_EVENTS_WITH_PROVIDER
                                                                                                                                                                                                                                                                                                                                            • SYSTEM$IS_GLOBAL_DATA_SHARING_ENABLED_FOR_ACCOUNT
                                                                                                                                                                                                                                                                                                                                              • SYSTEM$IS_LISTING_PURCHASED
                                                                                                                                                                                                                                                                                                                                                • SYSTEM$IS_LISTING_TRIAL
                                                                                                                                                                                                                                                                                                                                                  • SYSTEM$LAST_CHANGE_COMMIT_TIME
                                                                                                                                                                                                                                                                                                                                                    • SYSTEM$LIST_APPLICATION_RESTRICTED_FEATURES
                                                                                                                                                                                                                                                                                                                                                      • SYSTEM$LIST_ICEBERG_TABLES_FROM_CATALOG
                                                                                                                                                                                                                                                                                                                                                        • SYSTEM$LIST_NAMESPACES_FROM_CATALOG
                                                                                                                                                                                                                                                                                                                                                          • SYSTEM$LOG
                                                                                                                                                                                                                                                                                                                                                            • SYSTEM$PIPE_STATUS
                                                                                                                                                                                                                                                                                                                                                              • SYSTEM$QUERY_REFERENCE
                                                                                                                                                                                                                                                                                                                                                                • SYSTEM$READ_YAML_FROM_SEMANTIC_VIEW
                                                                                                                                                                                                                                                                                                                                                                  • SYSTEM$REFERENCE
                                                                                                                                                                                                                                                                                                                                                                    • SYSTEM$REGISTRY_LIST_IMAGES
                                                                                                                                                                                                                                                                                                                                                                      • SYSTEM$SET_RETURN_VALUE
                                                                                                                                                                                                                                                                                                                                                                        • SYSTEM$SET_SPAN_ATTRIBUTES
                                                                                                                                                                                                                                                                                                                                                                          • SYSTEM$SHOW_ACTIVE_BEHAVIOR_CHANGE_BUNDLES
                                                                                                                                                                                                                                                                                                                                                                            • SYSTEM$SHOW_BUDGETS_FOR_RESOURCE
                                                                                                                                                                                                                                                                                                                                                                              • SYSTEM$SHOW_BUDGETS_IN_ACCOUNT
                                                                                                                                                                                                                                                                                                                                                                                • SYSTEM$SHOW_EVENT_SHARING_ACCOUNTS
                                                                                                                                                                                                                                                                                                                                                                                  • SYSTEM$SHOW_MOVE_ORGANIZATION_ACCOUNT_STATUS
                                                                                                                                                                                                                                                                                                                                                                                    • SYSTEM$SHOW_OAUTH_CLIENT_SECRETS
                                                                                                                                                                                                                                                                                                                                                                                      • SYSTEM$SHOW_SENSITIVE_DATA_MONITORED_ENTITIES
                                                                                                                                                                                                                                                                                                                                                                                        • SYSTEM$STREAM_BACKLOG
                                                                                                                                                                                                                                                                                                                                                                                          • SYSTEM$STREAM_GET_TABLE_TIMESTAMP
                                                                                                                                                                                                                                                                                                                                                                                            • SYSTEM$STREAM_HAS_DATA
                                                                                                                                                                                                                                                                                                                                                                                              • SYSTEM$TASK_RUNTIME_INFO
                                                                                                                                                                                                                                                                                                                                                                                                • SYSTEM$TYPEOF
                                                                                                                                                                                                                                                                                                                                                                                                  • SYSTEM$VALIDATE_STORAGE_INTEGRATION
                                                                                                                                                                                                                                                                                                                                                                                                    • SYSTEM$VERIFY_CATALOG_INTEGRATION
                                                                                                                                                                                                                                                                                                                                                                                                      • SYSTEM$VERIFY_CMK_INFO
                                                                                                                                                                                                                                                                                                                                                                                                        • SYSTEM$VERIFY_EXTERNAL_OAUTH_TOKEN
                                                                                                                                                                                                                                                                                                                                                                                                          • SYSTEM$VERIFY_EXTERNAL_VOLUME
                                                                                                                                                                                                                                                                                                                                                                                                            • SYSTEM$WHITELIST
                                                                                                                                                                                                                                                                                                                                                                                                              • SYSTEM$WAIT_FOR_SERVICES
                                                                                                                                                                                                                                                                                                                                                                                                                • SYSTEM$WHITELIST_PRIVATELINK
                                                                                                                                                                                                                                                                                                                                                                                                                  • Query information
                                                                                                                                                                                                                                                                                                                                                                                                                  • EXPLAIN_JSON
                                                                                                                                                                                                                                                                                                                                                                                                                    • GET_QUERY_OPERATOR_STATS
                                                                                                                                                                                                                                                                                                                                                                                                                      • GET_PYTHON_PROFILER_OUTPUT
                                                                                                                                                                                                                                                                                                                                                                                                                        • SYSTEM$ESTIMATE_QUERY_ACCELERATION
                                                                                                                                                                                                                                                                                                                                                                                                                          • SYSTEM$EXPLAIN_PLAN_JSON
                                                                                                                                                                                                                                                                                                                                                                                                                            • SYSTEM$EXPLAIN_JSON_TO_TEXT
                                                                                                                                                                                                                                                                                                                                                                                                                              • SYSTEM$GET_RESULTSET_STATUS
                                                                                                                                                                                                                                                                                                                                                                                                                            • Table
                                                                                                                                                                                                                                                                                                                                                                                                                            • Vector
                                                                                                                                                                                                                                                                                                                                                                                                                            • Window
                                                                                                                                                                                                                                                                                                                                                                                                                            • Stored procedures
                                                                                                                                                                                                                                                                                                                                                                                                                        • Class reference
                                                                                                                                                                                                                                                                                                                                                                                                                        • Scripting reference
                                                                                                                                                                                                                                                                                                                                                                                                                        • General reference
                                                                                                                                                                                                                                                                                                                                                                                                                        • API reference
                                                                                                                                                                                                                                                                                                                                                                                                                          ReferenceFunction and stored procedure referenceSystemSYSTEM$UNREGISTER_PRIVATELINK_ENDPOINT

                                                                                                                                                                                                                                                                                                                                                                                                                          SYSTEM$UNREGISTER_PRIVATELINK_ENDPOINT¶

                                                                                                                                                                                                                                                                                                                                                                                                                          Snowflake logo in black (no text) Business Critical Feature

                                                                                                                                                                                                                                                                                                                                                                                                                          This feature requires Business Critical (or higher).

                                                                                                                                                                                                                                                                                                                                                                                                                          To inquire about upgrading, contact Snowflake Support.

                                                                                                                                                                                                                                                                                                                                                                                                                          Unregisters a private connectivity endpoint to route your connection to the Snowflake service.

                                                                                                                                                                                                                                                                                                                                                                                                                          Syntax¶

                                                                                                                                                                                                                                                                                                                                                                                                                          AWS

                                                                                                                                                                                                                                                                                                                                                                                                                          SYSTEM$UNREGISTER_PRIVATELINK_ENDPOINT(
                                                                                                                                                                                                                                                                                                                                                                                                                            '<aws_private_endpoint_vpce_id>',
                                                                                                                                                                                                                                                                                                                                                                                                                            '<aws_account_id>',
                                                                                                                                                                                                                                                                                                                                                                                                                            '<token>'
                                                                                                                                                                                                                                                                                                                                                                                                                            )
                                                                                                                                                                                                                                                                                                                                                                                                                          
                                                                                                                                                                                                                                                                                                                                                                                                                          Copy

                                                                                                                                                                                                                                                                                                                                                                                                                          Azure

                                                                                                                                                                                                                                                                                                                                                                                                                          SYSTEM$UNREGISTER_PRIVATELINK_ENDPOINT(
                                                                                                                                                                                                                                                                                                                                                                                                                            '<azure_private_endpoint_link_id>',
                                                                                                                                                                                                                                                                                                                                                                                                                            '<azure_private_endpoint_resource_id>',
                                                                                                                                                                                                                                                                                                                                                                                                                            '<token>'
                                                                                                                                                                                                                                                                                                                                                                                                                            )
                                                                                                                                                                                                                                                                                                                                                                                                                          
                                                                                                                                                                                                                                                                                                                                                                                                                          Copy

                                                                                                                                                                                                                                                                                                                                                                                                                          Arguments¶

                                                                                                                                                                                                                                                                                                                                                                                                                          AWS

                                                                                                                                                                                                                                                                                                                                                                                                                          aws_private_endpoint_vpce_id

                                                                                                                                                                                                                                                                                                                                                                                                                          Specifies the identifier for your Amazon Web Services (AWS) virtual private cloud endpoint (AWS VPCEID).

                                                                                                                                                                                                                                                                                                                                                                                                                          To obtain the AWS VPCEID value, navigate through the AWS console or use the following command:

                                                                                                                                                                                                                                                                                                                                                                                                                          aws ec2 describe-vpc-endpoints
                                                                                                                                                                                                                                                                                                                                                                                                                          
                                                                                                                                                                                                                                                                                                                                                                                                                          Copy
                                                                                                                                                                                                                                                                                                                                                                                                                          aws_account_id

                                                                                                                                                                                                                                                                                                                                                                                                                          The 12-digit identifier that uniquely identifies your Amazon Web Services (AWS) account, as a string.

                                                                                                                                                                                                                                                                                                                                                                                                                          To obtain the AWS account ID value, navigate through the AWS console or use the following command:

                                                                                                                                                                                                                                                                                                                                                                                                                          aws sts get-caller-identity
                                                                                                                                                                                                                                                                                                                                                                                                                          
                                                                                                                                                                                                                                                                                                                                                                                                                          Copy

                                                                                                                                                                                                                                                                                                                                                                                                                          Azure

                                                                                                                                                                                                                                                                                                                                                                                                                          azure_private_endpoint_link_id

                                                                                                                                                                                                                                                                                                                                                                                                                          Specifies the identifier for your Microsoft Azure (Azure) virtual private cloud endpoint link (Azure LinkID).

                                                                                                                                                                                                                                                                                                                                                                                                                          To obtain the Azure LinkID value:

                                                                                                                                                                                                                                                                                                                                                                                                                          Run the SYSTEM$GET_PRIVATELINK_AUTHORIZED_ENDPOINTS system function.

                                                                                                                                                                                                                                                                                                                                                                                                                          azure_private_endpoint_resource_id

                                                                                                                                                                                                                                                                                                                                                                                                                          The identifier that uniquely identifies your Snowflake account in Microsoft Azure (Azure) as a string.

                                                                                                                                                                                                                                                                                                                                                                                                                          To obtain the Azure private endpoint resource Id, use the following command:

                                                                                                                                                                                                                                                                                                                                                                                                                          az network private-endpoint list --resource-group my_resource_group
                                                                                                                                                                                                                                                                                                                                                                                                                          
                                                                                                                                                                                                                                                                                                                                                                                                                          Copy
                                                                                                                                                                                                                                                                                                                                                                                                                          token

                                                                                                                                                                                                                                                                                                                                                                                                                          Specifies an access token to verify ownership of the private connectivity endpoint.

                                                                                                                                                                                                                                                                                                                                                                                                                          To obtain the token, you must have the corresponding read or describe privilege on the private connectivity endpoint at a minimum. For more information, see:

                                                                                                                                                                                                                                                                                                                                                                                                                          • AWS endpoint policies

                                                                                                                                                                                                                                                                                                                                                                                                                          • Azure private endpoint privileges

                                                                                                                                                                                                                                                                                                                                                                                                                          To obtain the token, use the following commands:

                                                                                                                                                                                                                                                                                                                                                                                                                          • For Snowflake on AWS:

                                                                                                                                                                                                                                                                                                                                                                                                                            aws sts get-federation-token --name snowflake --policy '{ "Version": "2012-10-17", "Statement"
                                                                                                                                                                                                                                                                                                                                                                                                                            : [ { "Effect": "Allow", "Action": ["ec2:DescribeVpcEndpoints"], "Resource": ["*"] } ] }'
                                                                                                                                                                                                                                                                                                                                                                                                                            
                                                                                                                                                                                                                                                                                                                                                                                                                            Copy
                                                                                                                                                                                                                                                                                                                                                                                                                          • For Snowflake on Azure:

                                                                                                                                                                                                                                                                                                                                                                                                                            az account get-access-token --subscription <subscription_id>
                                                                                                                                                                                                                                                                                                                                                                                                                            
                                                                                                                                                                                                                                                                                                                                                                                                                            Copy

                                                                                                                                                                                                                                                                                                                                                                                                                          For more information about limiting the scope of an access token, see:

                                                                                                                                                                                                                                                                                                                                                                                                                          • For Snowflake on AWS: Managing access token scope on Amazon Web Services

                                                                                                                                                                                                                                                                                                                                                                                                                          • For Snowflake on Azure: Managing access token scope on Microsoft Azure

                                                                                                                                                                                                                                                                                                                                                                                                                          Returns¶

                                                                                                                                                                                                                                                                                                                                                                                                                          Returns a status message about the registration of the private connectivity endpoint.

                                                                                                                                                                                                                                                                                                                                                                                                                          Usage notes¶

                                                                                                                                                                                                                                                                                                                                                                                                                          Only account administrators (users with the ACCOUNTADMIN role) can call this function.

                                                                                                                                                                                                                                                                                                                                                                                                                          Examples¶

                                                                                                                                                                                                                                                                                                                                                                                                                          Unregister a VPC endpoint for your Snowflake account. Note that the AccessKeyId, SecretAccessKey, and SessionToken values are truncated:

                                                                                                                                                                                                                                                                                                                                                                                                                          AWS

                                                                                                                                                                                                                                                                                                                                                                                                                          SELECT SYSTEM$UNREGISTER_PRIVATELINK_ENDPOINT(
                                                                                                                                                                                                                                                                                                                                                                                                                            'vpce-0c1...',
                                                                                                                                                                                                                                                                                                                                                                                                                            '174...',
                                                                                                                                                                                                                                                                                                                                                                                                                            '{
                                                                                                                                                                                                                                                                                                                                                                                                                              "Credentials": {
                                                                                                                                                                                                                                                                                                                                                                                                                                "AccessKeyId": "ASI...",
                                                                                                                                                                                                                                                                                                                                                                                                                                "SecretAccessKey": "aFP...",
                                                                                                                                                                                                                                                                                                                                                                                                                                "SessionToken": "Fwo...",
                                                                                                                                                                                                                                                                                                                                                                                                                                "Expiration": "2024-04-26 05:49:09+00:00"
                                                                                                                                                                                                                                                                                                                                                                                                                              },
                                                                                                                                                                                                                                                                                                                                                                                                                              "FederatedUser": {
                                                                                                                                                                                                                                                                                                                                                                                                                                "FederatedUserId": "0123...:snowflake",
                                                                                                                                                                                                                                                                                                                                                                                                                                "Arn": "arn:aws:sts::174...:federated-user/sam"
                                                                                                                                                                                                                                                                                                                                                                                                                              },
                                                                                                                                                                                                                                                                                                                                                                                                                              "PackedPolicySize": 9
                                                                                                                                                                                                                                                                                                                                                                                                                            }'
                                                                                                                                                                                                                                                                                                                                                                                                                          );
                                                                                                                                                                                                                                                                                                                                                                                                                          
                                                                                                                                                                                                                                                                                                                                                                                                                          Copy

                                                                                                                                                                                                                                                                                                                                                                                                                          Azure

                                                                                                                                                                                                                                                                                                                                                                                                                          SELECT SYSTEM$UNREGISTER_PRIVATELINK_ENDPOINT(
                                                                                                                                                                                                                                                                                                                                                                                                                            '123...',
                                                                                                                                                                                                                                                                                                                                                                                                                            '/subscriptions/0cc51670-.../resourceGroups/dbsec_test_rg/providers/Microsoft.Network/
                                                                                                                                                                                                                                                                                                                                                                                                                            privateEndpoints/...',
                                                                                                                                                                                                                                                                                                                                                                                                                            'eyJ...'
                                                                                                                                                                                                                                                                                                                                                                                                                            );
                                                                                                                                                                                                                                                                                                                                                                                                                          
                                                                                                                                                                                                                                                                                                                                                                                                                          Copy

                                                                                                                                                                                                                                                                                                                                                                                                                          Was this page helpful?

                                                                                                                                                                                                                                                                                                                                                                                                                          Visit Snowflake
                                                                                                                                                                                                                                                                                                                                                                                                                          Join the conversation
                                                                                                                                                                                                                                                                                                                                                                                                                          Develop with Snowflake
                                                                                                                                                                                                                                                                                                                                                                                                                          Share your feedback
                                                                                                                                                                                                                                                                                                                                                                                                                          Read the latest on our blog
                                                                                                                                                                                                                                                                                                                                                                                                                          Get your own certification
                                                                                                                                                                                                                                                                                                                                                                                                                          Privacy NoticeSite TermsCookies Settings© 2025 Snowflake, Inc. All Rights Reserved.
                                                                                                                                                                                                                                                                                                                                                                                                                          1. Syntax
                                                                                                                                                                                                                                                                                                                                                                                                                          2. Arguments
                                                                                                                                                                                                                                                                                                                                                                                                                          3. Returns
                                                                                                                                                                                                                                                                                                                                                                                                                          4. Usage notes
                                                                                                                                                                                                                                                                                                                                                                                                                          5. Examples
                                                                                                                                                                                                                                                                                                                                                                                                                          Language: English
                                                                                                                                                                                                                                                                                                                                                                                                                          • English
                                                                                                                                                                                                                                                                                                                                                                                                                          • Français
                                                                                                                                                                                                                                                                                                                                                                                                                          • Deutsch
                                                                                                                                                                                                                                                                                                                                                                                                                          • 日本語
                                                                                                                                                                                                                                                                                                                                                                                                                          • 한국어
                                                                                                                                                                                                                                                                                                                                                                                                                          • Português