SYSTEM$GET_PRIVATELINK_ENDPOINTS_INFO¶

Syntax¶

SYSTEM$GET_PRIVATELINK_ENDPOINTS_INFO()

Returns¶

Returns a JSON object with the following fields:

AWS:

provider_service_name

Name of the service or resource.

snowflake_endpoint_name

The VPC endpoint ID in your Snowflake account. This field contains a temporary name while the endpoint is being created. After the endpoint is created, and endpoint_state changes to CREATED, then this name changes.

endpoint_state

The endpoint state in Snowflake. This field can contain one of the following states:

• PENDING_CREATION: The endpoint is still being created.

• CREATED: The endpoint is created and ready to use. This state indicates that Snowflake received a response from the cloud provider about the endpoint being successfully created.

• FAILED: The endpoint is in an unexpected state on the cloud provider, and cannot be used.

• PENDING_DELETION: The endpoint is on the deletion queue, but can be restored.

• DELETING: The endpoint is being deleted on the cloud provider and cannot be restored.

host

Hostname used to connect to the service.

status

The endpoint provisioning status on AWS. This field can contain one of the following statuses:

• Pending: The endpoint is still being created.

• Available: The endpoint is created and ready to use.

Azure:

provider_resource_id

Azure Resource ID of the resource that the endpoint connects to.

subresource

Subresource of the Azure resource that the endpoint connects to.

snowflake_resource_id

Azure Resource ID of the private endpoint that connects to the Azure resource.

host

Hostname used to connect to the resource.

endpoint_state

The endpoint state in Snowflake. This field can contain one of the following states:

• PENDING_CREATION: The endpoint is still being created.

• CREATED: The endpoint is created and ready to use. This state indicates that Snowflake received a response from the cloud provider about the endpoint being successfully created.

• FAILED: The endpoint is in an unexpected state on the cloud provider, and cannot be used.

• PENDING_DELETION: The endpoint is on the deletion queue, but can be restored.

• DELETING: The endpoint is being deleted on the cloud provider and cannot be restored.

status

The endpoint provisioning status on Microsoft Azure. Use this field to determine if Microsoft Azure has approved the private endpoint connection to the resource. This field can contain one of the following statues:

• APPROVED

• PENDING

• DISCONNECTED

• REJECTED

Usage notes¶

This function can take approximately 5 minutes to execute because it depends on the process to retrieve the private connectivity endpoints in the cloud platform (outside of Snowflake).

Examples¶

AWS:

List all PrivateLink endpoints with external access to Amazon S3, execute the following SQL statement:

SELECT SYSTEM$GET_PRIVATELINK_ENDPOINTS_INFO();

[
  {
    "provider_service_name": "com.amazonaws.us-west-2.s3",
    "snowflake_endpoint_name": "vpce-123456789012abcdea",
    "endpoint_state": "CREATED",
    "host": "*.s3.us-west-2.amazonaws.com",
    "status": "Available"
  },
  ...
]

Azure:

For your Snowflake account on Microsoft Azure, list the private connectivity endpoints that you provisioned and the service names that each endpoint is associated with:

SQLReturned value

SELECT SYSTEM$GET_PRIVATELINK_ENDPOINTS_INFO();

Copy