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.MechanicalTurk.ListHITs

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

The ListHITs operation returns all of a Requester's HITs. The operation returns HITs of any status, except for HITs that have been deleted of with the DeleteHIT operation or that have been auto-deleted.

This operation returns paginated results.

Synopsis

data ListHITs = ListHITs' {
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
}
newListHITs :: ListHITs
listHITs_maxResults :: Lens' ListHITs (Maybe Natural)
listHITs_nextToken :: Lens' ListHITs (Maybe Text)
data ListHITsResponse = ListHITsResponse' {
- hITs :: Maybe [HIT]
- nextToken :: Maybe Text
- numResults :: Maybe Int
- httpStatus :: Int
}
newListHITsResponse :: Int -> ListHITsResponse
listHITsResponse_hITs :: Lens' ListHITsResponse (Maybe [HIT])
listHITsResponse_nextToken :: Lens' ListHITsResponse (Maybe Text)
listHITsResponse_numResults :: Lens' ListHITsResponse (Maybe Int)
listHITsResponse_httpStatus :: Lens' ListHITsResponse Int

Creating a Request

data ListHITs Source #

See: newListHITs smart constructor.

Constructors

ListHITs'
Fields maxResults :: Maybe Natural nextToken :: Maybe Text Pagination token

Instances

Instances details

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

newListHITs :: ListHITs Source #

Create a value of ListHITs 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:maxResults:ListHITs', listHITs_maxResults - Undocumented member.

ListHITs, listHITs_nextToken - Pagination token

Request Lenses

listHITs_maxResults :: Lens' ListHITs (Maybe Natural) Source #

Undocumented member.

listHITs_nextToken :: Lens' ListHITs (Maybe Text) Source #

Pagination token

Destructuring the Response

data ListHITsResponse Source #

See: newListHITsResponse smart constructor.

Constructors

ListHITsResponse'
Fields hITs :: Maybe [HIT] The list of HIT elements returned by the query. nextToken :: Maybe Text numResults :: Maybe Int The number of HITs on this page in the filtered results list, equivalent to the number of HITs being returned by this call. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newListHITsResponse Source #

Arguments

:: Int	`$sel:httpStatus:ListHITsResponse'`
-> ListHITsResponse

Create a value of ListHITsResponse 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:hITs:ListHITsResponse', listHITsResponse_hITs - The list of HIT elements returned by the query.

ListHITs, listHITsResponse_nextToken - Undocumented member.

$sel:numResults:ListHITsResponse', listHITsResponse_numResults - The number of HITs on this page in the filtered results list, equivalent to the number of HITs being returned by this call.

$sel:httpStatus:ListHITsResponse', listHITsResponse_httpStatus - The response's http status code.

Response Lenses

listHITsResponse_hITs :: Lens' ListHITsResponse (Maybe [HIT]) Source #

The list of HIT elements returned by the query.

listHITsResponse_nextToken :: Lens' ListHITsResponse (Maybe Text) Source #

Undocumented member.

listHITsResponse_numResults :: Lens' ListHITsResponse (Maybe Int) Source #

The number of HITs on this page in the filtered results list, equivalent to the number of HITs being returned by this call.

listHITsResponse_httpStatus :: Lens' ListHITsResponse Int Source #

The response's http status code.