Skip to content

Get Query State

lakeformation_get_query_state R Documentation

Returns the state of a query previously submitted

Description

Returns the state of a query previously submitted. Clients are expected to poll get_query_state to monitor the current state of the planning before retrieving the work units. A query state is only visible to the principal that made the initial call to start_query_planning.

Usage

lakeformation_get_query_state(QueryId)

Arguments

QueryId

[required] The ID of the plan query operation.

Value

A list with the following syntax:

list(
  Error = "string",
  State = "PENDING"|"WORKUNITS_AVAILABLE"|"ERROR"|"FINISHED"|"EXPIRED"
)

Request syntax

svc$get_query_state(
  QueryId = "string"
)