Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.LakeFormation.GetWorkUnits

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Retrieves the work units generated by the StartQueryPlanning operation.

This operation returns paginated results.

Creating a Request

data GetWorkUnits Source #

See: newGetWorkUnits smart constructor.

Constructors

GetWorkUnits'

Fields

nextToken :: Maybe Text
A continuation token, if this is a continuation call.
pageSize :: Maybe Int
The size of each page to get in the Amazon Web Services service call. This does not affect the number of items returned in the command's output. Setting a smaller page size results in more calls to the Amazon Web Services service, retrieving fewer items in each call. This can help prevent the Amazon Web Services service calls from timing out.
queryId :: Text
The ID of the plan query operation.

Instances

Instances details

ToJSON GetWorkUnits Source #
Instance details Defined in Amazonka.LakeFormation.GetWorkUnits Methods toJSON :: GetWorkUnits -> Value # toEncoding :: GetWorkUnits -> Encoding # toJSONList :: [GetWorkUnits] -> Value # toEncodingList :: [GetWorkUnits] -> Encoding #
ToHeaders GetWorkUnits Source #
Instance details Defined in Amazonka.LakeFormation.GetWorkUnits Methods toHeaders :: GetWorkUnits -> [Header] #
ToPath GetWorkUnits Source #
Instance details Defined in Amazonka.LakeFormation.GetWorkUnits Methods toPath :: GetWorkUnits -> ByteString #
ToQuery GetWorkUnits Source #
Instance details Defined in Amazonka.LakeFormation.GetWorkUnits Methods toQuery :: GetWorkUnits -> QueryString #
AWSPager GetWorkUnits Source #
Instance details Defined in Amazonka.LakeFormation.GetWorkUnits Methods page :: GetWorkUnits -> AWSResponse GetWorkUnits -> Maybe GetWorkUnits #
AWSRequest GetWorkUnits Source #
Instance details Defined in Amazonka.LakeFormation.GetWorkUnits Associated Types type AWSResponse GetWorkUnits # Methods request :: (Service -> Service) -> GetWorkUnits -> Request GetWorkUnits # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetWorkUnits -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetWorkUnits))) #
Generic GetWorkUnits Source #
Instance details Defined in Amazonka.LakeFormation.GetWorkUnits Associated Types type Rep GetWorkUnits :: Type -> Type # Methods from :: GetWorkUnits -> Rep GetWorkUnits x # to :: Rep GetWorkUnits x -> GetWorkUnits #
Read GetWorkUnits Source #
Instance details Defined in Amazonka.LakeFormation.GetWorkUnits Methods readsPrec :: Int -> ReadS GetWorkUnits # readList :: ReadS [GetWorkUnits] # readPrec :: ReadPrec GetWorkUnits # readListPrec :: ReadPrec [GetWorkUnits] #
Show GetWorkUnits Source #
Instance details Defined in Amazonka.LakeFormation.GetWorkUnits Methods showsPrec :: Int -> GetWorkUnits -> ShowS # show :: GetWorkUnits -> String # showList :: [GetWorkUnits] -> ShowS #
NFData GetWorkUnits Source #
Instance details Defined in Amazonka.LakeFormation.GetWorkUnits Methods rnf :: GetWorkUnits -> () #
Eq GetWorkUnits Source #
Instance details Defined in Amazonka.LakeFormation.GetWorkUnits Methods (==) :: GetWorkUnits -> GetWorkUnits -> Bool # (/=) :: GetWorkUnits -> GetWorkUnits -> Bool #
Hashable GetWorkUnits Source #
Instance details Defined in Amazonka.LakeFormation.GetWorkUnits Methods hashWithSalt :: Int -> GetWorkUnits -> Int # hash :: GetWorkUnits -> Int #
type AWSResponse GetWorkUnits Source #
Instance details Defined in Amazonka.LakeFormation.GetWorkUnits type AWSResponse GetWorkUnits = GetWorkUnitsResponse
type Rep GetWorkUnits Source #
Instance details Defined in Amazonka.LakeFormation.GetWorkUnits type Rep GetWorkUnits = D1 ('MetaData "GetWorkUnits" "Amazonka.LakeFormation.GetWorkUnits" "amazonka-lakeformation-2.0-HHqQokxI1tpCfoS44CTFPa" 'False) (C1 ('MetaCons "GetWorkUnits'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "pageSize") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: S1 ('MetaSel ('Just "queryId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newGetWorkUnits Source #

Arguments

:: Text	`GetWorkUnits`
-> GetWorkUnits

Create a value of GetWorkUnits 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:

GetWorkUnits, getWorkUnits_nextToken - A continuation token, if this is a continuation call.

$sel:pageSize:GetWorkUnits', getWorkUnits_pageSize - The size of each page to get in the Amazon Web Services service call. This does not affect the number of items returned in the command's output. Setting a smaller page size results in more calls to the Amazon Web Services service, retrieving fewer items in each call. This can help prevent the Amazon Web Services service calls from timing out.

GetWorkUnits, getWorkUnits_queryId - The ID of the plan query operation.

Request Lenses

getWorkUnits_nextToken :: Lens' GetWorkUnits (Maybe Text) Source #

A continuation token, if this is a continuation call.

getWorkUnits_pageSize :: Lens' GetWorkUnits (Maybe Int) Source #

The size of each page to get in the Amazon Web Services service call. This does not affect the number of items returned in the command's output. Setting a smaller page size results in more calls to the Amazon Web Services service, retrieving fewer items in each call. This can help prevent the Amazon Web Services service calls from timing out.

getWorkUnits_queryId :: Lens' GetWorkUnits Text Source #

The ID of the plan query operation.

Destructuring the Response

data GetWorkUnitsResponse Source #

A structure for the output.

See: newGetWorkUnitsResponse smart constructor.

Constructors

GetWorkUnitsResponse'

Fields

nextToken :: Maybe Text
A continuation token for paginating the returned list of tokens, returned if the current segment of the list is not the last.
httpStatus :: Int
The response's http status code.
queryId :: Text
The ID of the plan query operation.
workUnitRanges :: [WorkUnitRange]
A WorkUnitRangeList object that specifies the valid range of work unit IDs for querying the execution service.

Instances

Instances details

Generic GetWorkUnitsResponse Source #
Instance details Defined in Amazonka.LakeFormation.GetWorkUnits Associated Types type Rep GetWorkUnitsResponse :: Type -> Type # Methods from :: GetWorkUnitsResponse -> Rep GetWorkUnitsResponse x # to :: Rep GetWorkUnitsResponse x -> GetWorkUnitsResponse #
Read GetWorkUnitsResponse Source #
Instance details Defined in Amazonka.LakeFormation.GetWorkUnits Methods readsPrec :: Int -> ReadS GetWorkUnitsResponse # readList :: ReadS [GetWorkUnitsResponse] # readPrec :: ReadPrec GetWorkUnitsResponse # readListPrec :: ReadPrec [GetWorkUnitsResponse] #
Show GetWorkUnitsResponse Source #
Instance details Defined in Amazonka.LakeFormation.GetWorkUnits Methods showsPrec :: Int -> GetWorkUnitsResponse -> ShowS # show :: GetWorkUnitsResponse -> String # showList :: [GetWorkUnitsResponse] -> ShowS #
NFData GetWorkUnitsResponse Source #
Instance details Defined in Amazonka.LakeFormation.GetWorkUnits Methods rnf :: GetWorkUnitsResponse -> () #
Eq GetWorkUnitsResponse Source #
Instance details Defined in Amazonka.LakeFormation.GetWorkUnits Methods (==) :: GetWorkUnitsResponse -> GetWorkUnitsResponse -> Bool # (/=) :: GetWorkUnitsResponse -> GetWorkUnitsResponse -> Bool #
type Rep GetWorkUnitsResponse Source #
Instance details Defined in Amazonka.LakeFormation.GetWorkUnits type Rep GetWorkUnitsResponse = D1 ('MetaData "GetWorkUnitsResponse" "Amazonka.LakeFormation.GetWorkUnits" "amazonka-lakeformation-2.0-HHqQokxI1tpCfoS44CTFPa" 'False) (C1 ('MetaCons "GetWorkUnitsResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)) :: (S1 ('MetaSel ('Just "queryId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "workUnitRanges") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [WorkUnitRange]))))

newGetWorkUnitsResponse Source #

Arguments

:: Int	`$sel:httpStatus:GetWorkUnitsResponse'`
-> Text	`GetWorkUnits`
-> GetWorkUnitsResponse

Create a value of GetWorkUnitsResponse 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:

GetWorkUnits, getWorkUnitsResponse_nextToken - A continuation token for paginating the returned list of tokens, returned if the current segment of the list is not the last.

$sel:httpStatus:GetWorkUnitsResponse', getWorkUnitsResponse_httpStatus - The response's http status code.

GetWorkUnits, getWorkUnitsResponse_queryId - The ID of the plan query operation.

$sel:workUnitRanges:GetWorkUnitsResponse', getWorkUnitsResponse_workUnitRanges - A WorkUnitRangeList object that specifies the valid range of work unit IDs for querying the execution service.

Response Lenses

getWorkUnitsResponse_nextToken :: Lens' GetWorkUnitsResponse (Maybe Text) Source #

A continuation token for paginating the returned list of tokens, returned if the current segment of the list is not the last.

getWorkUnitsResponse_httpStatus :: Lens' GetWorkUnitsResponse Int Source #

The response's http status code.

getWorkUnitsResponse_queryId :: Lens' GetWorkUnitsResponse Text Source #

The ID of the plan query operation.

getWorkUnitsResponse_workUnitRanges :: Lens' GetWorkUnitsResponse [WorkUnitRange] Source #

A WorkUnitRangeList object that specifies the valid range of work unit IDs for querying the execution service.