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.ListReviewableHITs

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

The ListReviewableHITs operation retrieves the HITs with Status equal to Reviewable or Status equal to Reviewing that belong to the Requester calling the operation.

This operation returns paginated results.

Synopsis

data ListReviewableHITs = ListReviewableHITs' {
- hITTypeId :: Maybe Text
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
- status :: Maybe ReviewableHITStatus
}
newListReviewableHITs :: ListReviewableHITs
listReviewableHITs_hITTypeId :: Lens' ListReviewableHITs (Maybe Text)
listReviewableHITs_maxResults :: Lens' ListReviewableHITs (Maybe Natural)
listReviewableHITs_nextToken :: Lens' ListReviewableHITs (Maybe Text)
listReviewableHITs_status :: Lens' ListReviewableHITs (Maybe ReviewableHITStatus)
data ListReviewableHITsResponse = ListReviewableHITsResponse' {
- hITs :: Maybe [HIT]
- nextToken :: Maybe Text
- numResults :: Maybe Int
- httpStatus :: Int
}
newListReviewableHITsResponse :: Int -> ListReviewableHITsResponse
listReviewableHITsResponse_hITs :: Lens' ListReviewableHITsResponse (Maybe [HIT])
listReviewableHITsResponse_nextToken :: Lens' ListReviewableHITsResponse (Maybe Text)
listReviewableHITsResponse_numResults :: Lens' ListReviewableHITsResponse (Maybe Int)
listReviewableHITsResponse_httpStatus :: Lens' ListReviewableHITsResponse Int

Creating a Request

data ListReviewableHITs Source #

See: newListReviewableHITs smart constructor.

Constructors

ListReviewableHITs'
Fields hITTypeId :: Maybe Text The ID of the HIT type of the HITs to consider for the query. If not specified, all HITs for the Reviewer are considered maxResults :: Maybe Natural Limit the number of results returned. nextToken :: Maybe Text Pagination Token status :: Maybe ReviewableHITStatus Can be either `Reviewable` or `Reviewing`. Reviewable is the default value.

Instances

Instances details

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

newListReviewableHITs :: ListReviewableHITs Source #

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

ListReviewableHITs, listReviewableHITs_hITTypeId - The ID of the HIT type of the HITs to consider for the query. If not specified, all HITs for the Reviewer are considered

$sel:maxResults:ListReviewableHITs', listReviewableHITs_maxResults - Limit the number of results returned.

ListReviewableHITs, listReviewableHITs_nextToken - Pagination Token

ListReviewableHITs, listReviewableHITs_status - Can be either Reviewable or Reviewing. Reviewable is the default value.

Request Lenses

listReviewableHITs_hITTypeId :: Lens' ListReviewableHITs (Maybe Text) Source #

The ID of the HIT type of the HITs to consider for the query. If not specified, all HITs for the Reviewer are considered

listReviewableHITs_maxResults :: Lens' ListReviewableHITs (Maybe Natural) Source #

Limit the number of results returned.

listReviewableHITs_nextToken :: Lens' ListReviewableHITs (Maybe Text) Source #

Pagination Token

listReviewableHITs_status :: Lens' ListReviewableHITs (Maybe ReviewableHITStatus) Source #

Can be either Reviewable or Reviewing. Reviewable is the default value.

Destructuring the Response

data ListReviewableHITsResponse Source #

See: newListReviewableHITsResponse smart constructor.

Constructors

ListReviewableHITsResponse'
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 ListReviewableHITsResponse Source #
Instance details Defined in Amazonka.MechanicalTurk.ListReviewableHITs Associated Types type Rep ListReviewableHITsResponse :: Type -> Type # Methods from :: ListReviewableHITsResponse -> Rep ListReviewableHITsResponse x # to :: Rep ListReviewableHITsResponse x -> ListReviewableHITsResponse #
Read ListReviewableHITsResponse Source #
Instance details Defined in Amazonka.MechanicalTurk.ListReviewableHITs Methods readsPrec :: Int -> ReadS ListReviewableHITsResponse # readList :: ReadS [ListReviewableHITsResponse] # readPrec :: ReadPrec ListReviewableHITsResponse # readListPrec :: ReadPrec [ListReviewableHITsResponse] #
Show ListReviewableHITsResponse Source #
Instance details Defined in Amazonka.MechanicalTurk.ListReviewableHITs Methods showsPrec :: Int -> ListReviewableHITsResponse -> ShowS # show :: ListReviewableHITsResponse -> String # showList :: [ListReviewableHITsResponse] -> ShowS #
NFData ListReviewableHITsResponse Source #
Instance details Defined in Amazonka.MechanicalTurk.ListReviewableHITs Methods rnf :: ListReviewableHITsResponse -> () #
Eq ListReviewableHITsResponse Source #
Instance details Defined in Amazonka.MechanicalTurk.ListReviewableHITs Methods (==) :: ListReviewableHITsResponse -> ListReviewableHITsResponse -> Bool # (/=) :: ListReviewableHITsResponse -> ListReviewableHITsResponse -> Bool #
type Rep ListReviewableHITsResponse Source #
Instance details Defined in Amazonka.MechanicalTurk.ListReviewableHITs type Rep ListReviewableHITsResponse = D1 ('MetaData "ListReviewableHITsResponse" "Amazonka.MechanicalTurk.ListReviewableHITs" "amazonka-mechanicalturk-2.0-7Thix2UjvlJINPIH68shk3" 'False) (C1 ('MetaCons "ListReviewableHITsResponse'" '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))))

newListReviewableHITsResponse Source #

Arguments

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

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

ListReviewableHITs, listReviewableHITsResponse_nextToken - Undocumented member.

$sel:numResults:ListReviewableHITsResponse', listReviewableHITsResponse_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:ListReviewableHITsResponse', listReviewableHITsResponse_httpStatus - The response's http status code.

Response Lenses

listReviewableHITsResponse_hITs :: Lens' ListReviewableHITsResponse (Maybe [HIT]) Source #

The list of HIT elements returned by the query.

listReviewableHITsResponse_nextToken :: Lens' ListReviewableHITsResponse (Maybe Text) Source #

Undocumented member.

listReviewableHITsResponse_numResults :: Lens' ListReviewableHITsResponse (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.

listReviewableHITsResponse_httpStatus :: Lens' ListReviewableHITsResponse Int Source #

The response's http status code.