Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

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

Creating a Request

data ListReviewableHITs Source #

See: newListReviewableHITs smart constructor.

Constructors

ListReviewableHITs'
Fields status :: Maybe ReviewableHITStatus Can be either `Reviewable` or `Reviewing`. Reviewable is the default value. 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 nextToken :: Maybe Text Pagination Token maxResults :: Maybe Natural Limit the number of results returned.

Instances

Instances details

Eq ListReviewableHITs Source #
Instance details Defined in Amazonka.MechanicalTurk.ListReviewableHITs Methods (==) :: ListReviewableHITs -> ListReviewableHITs -> Bool # (/=) :: ListReviewableHITs -> ListReviewableHITs -> Bool #
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 #
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 #
NFData ListReviewableHITs Source #
Instance details Defined in Amazonka.MechanicalTurk.ListReviewableHITs Methods rnf :: ListReviewableHITs -> () #
Hashable ListReviewableHITs Source #
Instance details Defined in Amazonka.MechanicalTurk.ListReviewableHITs Methods hashWithSalt :: Int -> ListReviewableHITs -> Int # hash :: ListReviewableHITs -> Int #
ToJSON ListReviewableHITs Source #
Instance details Defined in Amazonka.MechanicalTurk.ListReviewableHITs Methods toJSON :: ListReviewableHITs -> Value # toEncoding :: ListReviewableHITs -> Encoding # toJSONList :: [ListReviewableHITs] -> Value # toEncodingList :: [ListReviewableHITs] -> Encoding #
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 :: ListReviewableHITs -> Request ListReviewableHITs # response :: MonadResource m => Logger -> Service -> Proxy ListReviewableHITs -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListReviewableHITs))) #
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 #
type Rep ListReviewableHITs Source #
Instance details Defined in Amazonka.MechanicalTurk.ListReviewableHITs type Rep ListReviewableHITs = D1 ('MetaData "ListReviewableHITs" "Amazonka.MechanicalTurk.ListReviewableHITs" "libZSservicesZSamazonka-mechanicalturkZSamazonka-mechanicalturk" 'False) (C1 ('MetaCons "ListReviewableHITs'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ReviewableHITStatus)) :: S1 ('MetaSel ('Just "hITTypeId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)))))
type AWSResponse ListReviewableHITs Source #
Instance details Defined in Amazonka.MechanicalTurk.ListReviewableHITs type AWSResponse ListReviewableHITs = ListReviewableHITsResponse

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:

$sel:status:ListReviewableHITs', listReviewableHITs_status - Can be either Reviewable or Reviewing. Reviewable is the default value.

$sel:hITTypeId: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:nextToken:ListReviewableHITs', listReviewableHITs_nextToken - Pagination Token

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

Request Lenses

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

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

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_nextToken :: Lens' ListReviewableHITs (Maybe Text) Source #

Pagination Token

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

Limit the number of results returned.

Destructuring the Response

data ListReviewableHITsResponse Source #

See: newListReviewableHITsResponse smart constructor.

Constructors

ListReviewableHITsResponse'
Fields 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. hITs :: Maybe [HIT] The list of HIT elements returned by the query. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq ListReviewableHITsResponse Source #
Instance details Defined in Amazonka.MechanicalTurk.ListReviewableHITs Methods (==) :: ListReviewableHITsResponse -> ListReviewableHITsResponse -> Bool # (/=) :: ListReviewableHITsResponse -> ListReviewableHITsResponse -> Bool #
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 #
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 #
NFData ListReviewableHITsResponse Source #
Instance details Defined in Amazonka.MechanicalTurk.ListReviewableHITs Methods rnf :: ListReviewableHITsResponse -> () #
type Rep ListReviewableHITsResponse Source #
Instance details Defined in Amazonka.MechanicalTurk.ListReviewableHITs type Rep ListReviewableHITsResponse = D1 ('MetaData "ListReviewableHITsResponse" "Amazonka.MechanicalTurk.ListReviewableHITs" "libZSservicesZSamazonka-mechanicalturkZSamazonka-mechanicalturk" 'False) (C1 ('MetaCons "ListReviewableHITsResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "numResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))) :: (S1 ('MetaSel ('Just "hITs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [HIT])) :*: 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:nextToken: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:hITs:ListReviewableHITsResponse', listReviewableHITsResponse_hITs - The list of HIT elements returned by the query.

$sel:httpStatus:ListReviewableHITsResponse', listReviewableHITsResponse_httpStatus - The response's http status code.

Response Lenses

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_hITs :: Lens' ListReviewableHITsResponse (Maybe [HIT]) Source #

The list of HIT elements returned by the query.

listReviewableHITsResponse_httpStatus :: Lens' ListReviewableHITsResponse Int Source #

The response's http status code.