Jump to Content

This API Documentation is now deprecated

We are excited to announce our new API Documentation.

Interface GetQueryStateCommandOutputProtected

The output of GetQueryStateCommand.

Hierarchy

Properties

Properties

Error?: string

An error message when the operation fails.

State: undefined | string

The state of a query previously submitted. The possible states are:

  • PENDING: the query is pending.

  • WORKUNITS_AVAILABLE: some work units are ready for retrieval and execution.

  • FINISHED: the query planning finished successfully, and all work units are ready for retrieval and execution.

  • ERROR: an error occurred with the query, such as an invalid query ID or a backend error.