Amazonka.LakeFormation.GetQueryState

Returns the state of a query previously submitted. Clients are expected to poll GetQueryState 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 StartQueryPlanning.

Creating a Request

data GetQueryState

See: newGetQueryState smart constructor.

Constructors

GetQueryState'

Fields

• queryId :: Text

  The ID of the plan query operation.

Instances

ToJSON GetQueryState

Defined in Amazonka.LakeFormation.GetQueryState

Methods

toJSON :: GetQueryState -> Value

toEncoding :: GetQueryState -> Encoding

toJSONList :: [GetQueryState] -> Value

toEncodingList :: [GetQueryState] -> Encoding

ToHeaders GetQueryState

Defined in Amazonka.LakeFormation.GetQueryState

Methods

toHeaders :: GetQueryState -> [Header]

ToPath GetQueryState

Defined in Amazonka.LakeFormation.GetQueryState

Methods

toPath :: GetQueryState -> ByteString

ToQuery GetQueryState

Defined in Amazonka.LakeFormation.GetQueryState

Methods

toQuery :: GetQueryState -> QueryString

AWSRequest GetQueryState

Defined in Amazonka.LakeFormation.GetQueryState

Associated Types

type AWSResponse GetQueryState

Methods

request :: (Service -> Service) -> GetQueryState -> Request GetQueryState

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetQueryState -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetQueryState)))

Generic GetQueryState

Defined in Amazonka.LakeFormation.GetQueryState

Associated Types

type Rep GetQueryState :: Type -> Type

Methods

from :: GetQueryState -> Rep GetQueryState x

to :: Rep GetQueryState x -> GetQueryState

Read GetQueryState

Defined in Amazonka.LakeFormation.GetQueryState

Methods

readsPrec :: Int -> ReadS GetQueryState

readList :: ReadS [GetQueryState]

readPrec :: ReadPrec GetQueryState

readListPrec :: ReadPrec [GetQueryState]

Show GetQueryState

Defined in Amazonka.LakeFormation.GetQueryState

Methods

showsPrec :: Int -> GetQueryState -> ShowS

show :: GetQueryState -> String

showList :: [GetQueryState] -> ShowS

NFData GetQueryState

Defined in Amazonka.LakeFormation.GetQueryState

Methods

rnf :: GetQueryState -> ()

Eq GetQueryState

Defined in Amazonka.LakeFormation.GetQueryState

Methods

(==) :: GetQueryState -> GetQueryState -> Bool

(/=) :: GetQueryState -> GetQueryState -> Bool

Hashable GetQueryState

Defined in Amazonka.LakeFormation.GetQueryState

Methods

hashWithSalt :: Int -> GetQueryState -> Int

hash :: GetQueryState -> Int

type AWSResponse GetQueryState

Defined in Amazonka.LakeFormation.GetQueryState

type AWSResponse GetQueryState = GetQueryStateResponse

type Rep GetQueryState

Defined in Amazonka.LakeFormation.GetQueryState

type Rep GetQueryState = D1 ('MetaData "GetQueryState" "Amazonka.LakeFormation.GetQueryState" "amazonka-lakeformation-2.0-HHqQokxI1tpCfoS44CTFPa" 'False) (C1 ('MetaCons "GetQueryState'" 'PrefixI 'True) (S1 ('MetaSel ('Just "queryId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newGetQueryState

Arguments

:: Text

$sel:queryId:GetQueryState'

-> GetQueryState

Create a value of GetQueryState with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:queryId:GetQueryState', getQueryState_queryId - The ID of the plan query operation.

Request Lenses

getQueryState_queryId :: Lens' GetQueryState Text

The ID of the plan query operation.

Destructuring the Response

data GetQueryStateResponse

A structure for the output.

See: newGetQueryStateResponse smart constructor.

Constructors

GetQueryStateResponse'

Fields

• error :: Maybe Text

  An error message when the operation fails.

• httpStatus :: Int

  The response's http status code.

• state :: QueryStateString

  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.

Instances

Generic GetQueryStateResponse

Defined in Amazonka.LakeFormation.GetQueryState

Associated Types

type Rep GetQueryStateResponse :: Type -> Type

Methods

from :: GetQueryStateResponse -> Rep GetQueryStateResponse x

to :: Rep GetQueryStateResponse x -> GetQueryStateResponse

Read GetQueryStateResponse

Defined in Amazonka.LakeFormation.GetQueryState

Methods

readsPrec :: Int -> ReadS GetQueryStateResponse

readList :: ReadS [GetQueryStateResponse]

readPrec :: ReadPrec GetQueryStateResponse

readListPrec :: ReadPrec [GetQueryStateResponse]

Show GetQueryStateResponse

Defined in Amazonka.LakeFormation.GetQueryState

Methods

showsPrec :: Int -> GetQueryStateResponse -> ShowS

show :: GetQueryStateResponse -> String

showList :: [GetQueryStateResponse] -> ShowS

NFData GetQueryStateResponse

Defined in Amazonka.LakeFormation.GetQueryState

Methods

rnf :: GetQueryStateResponse -> ()

Eq GetQueryStateResponse

Defined in Amazonka.LakeFormation.GetQueryState

Methods

(==) :: GetQueryStateResponse -> GetQueryStateResponse -> Bool

(/=) :: GetQueryStateResponse -> GetQueryStateResponse -> Bool

type Rep GetQueryStateResponse

Defined in Amazonka.LakeFormation.GetQueryState

type Rep GetQueryStateResponse = D1 ('MetaData "GetQueryStateResponse" "Amazonka.LakeFormation.GetQueryState" "amazonka-lakeformation-2.0-HHqQokxI1tpCfoS44CTFPa" 'False) (C1 ('MetaCons "GetQueryStateResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "error") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "state") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 QueryStateString))))

newGetQueryStateResponse

Arguments

:: Int

$sel:httpStatus:GetQueryStateResponse'

-> QueryStateString

$sel:state:GetQueryStateResponse'

-> GetQueryStateResponse

Create a value of GetQueryStateResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

GetQueryStateResponse, getQueryStateResponse_error - An error message when the operation fails.

$sel:httpStatus:GetQueryStateResponse', getQueryStateResponse_httpStatus - The response's http status code.

$sel:state:GetQueryStateResponse', getQueryStateResponse_state - 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.

Response Lenses

getQueryStateResponse_error :: Lens' GetQueryStateResponse (Maybe Text)

An error message when the operation fails.

getQueryStateResponse_httpStatus :: Lens' GetQueryStateResponse Int

The response's http status code.

getQueryStateResponse_state :: Lens' GetQueryStateResponse QueryStateString

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.