libZSservicesZSamazonka-mechanicalturkZSamazonka-mechanicalturk
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.MechanicalTurk.ListReviewPolicyResultsForHIT

Description

The ListReviewPolicyResultsForHIT operation retrieves the computed results and the actions taken in the course of executing your Review Policies for a given HIT. For information about how to specify Review Policies when you call CreateHIT, see Review Policies. The ListReviewPolicyResultsForHIT operation can return results for both Assignment-level and HIT-level review results.

Synopsis

Creating a Request

data ListReviewPolicyResultsForHIT Source #

See: newListReviewPolicyResultsForHIT smart constructor.

Constructors

ListReviewPolicyResultsForHIT' 

Fields

  • retrieveResults :: Maybe Bool

    Specify if the operation should retrieve a list of the results computed by the Review Policies.

  • policyLevels :: Maybe [ReviewPolicyLevel]

    The Policy Level(s) to retrieve review results for - HIT or Assignment. If omitted, the default behavior is to retrieve all data for both policy levels. For a list of all the described policies, see Review Policies.

  • retrieveActions :: Maybe Bool

    Specify if the operation should retrieve a list of the actions taken executing the Review Policies and their outcomes.

  • nextToken :: Maybe Text

    Pagination token

  • maxResults :: Maybe Natural

    Limit the number of results returned.

  • hITId :: Text

    The unique identifier of the HIT to retrieve review results for.

Instances

Instances details
Eq ListReviewPolicyResultsForHIT Source # 
Instance details

Defined in Amazonka.MechanicalTurk.ListReviewPolicyResultsForHIT

Methods

(==) :: ListReviewPolicyResultsForHIT -> ListReviewPolicyResultsForHIT -> Bool #

(/=) :: ListReviewPolicyResultsForHIT -> ListReviewPolicyResultsForHIT -> Bool #

Read ListReviewPolicyResultsForHIT Source # 
Instance details

Defined in Amazonka.MechanicalTurk.ListReviewPolicyResultsForHIT

Methods

readsPrec :: Int -> ReadS ListReviewPolicyResultsForHIT #

readList :: ReadS [ListReviewPolicyResultsForHIT] #

readPrec :: ReadPrec ListReviewPolicyResultsForHIT #

readListPrec :: ReadPrec [ListReviewPolicyResultsForHIT] #

Show ListReviewPolicyResultsForHIT Source # 
Instance details

Defined in Amazonka.MechanicalTurk.ListReviewPolicyResultsForHIT

Methods

showsPrec :: Int -> ListReviewPolicyResultsForHIT -> ShowS #

show :: ListReviewPolicyResultsForHIT -> String #

showList :: [ListReviewPolicyResultsForHIT] -> ShowS #

Generic ListReviewPolicyResultsForHIT Source # 
Instance details

Defined in Amazonka.MechanicalTurk.ListReviewPolicyResultsForHIT

Associated Types

type Rep ListReviewPolicyResultsForHIT :: Type -> Type #

Methods

from :: ListReviewPolicyResultsForHIT -> Rep ListReviewPolicyResultsForHIT x #

to :: Rep ListReviewPolicyResultsForHIT x -> ListReviewPolicyResultsForHIT #

NFData ListReviewPolicyResultsForHIT Source # 
Instance details

Defined in Amazonka.MechanicalTurk.ListReviewPolicyResultsForHIT

Methods

rnf :: ListReviewPolicyResultsForHIT -> () #

Hashable ListReviewPolicyResultsForHIT Source # 
Instance details

Defined in Amazonka.MechanicalTurk.ListReviewPolicyResultsForHIT

Methods

hashWithSalt :: Int -> ListReviewPolicyResultsForHIT -> Int #

hash :: ListReviewPolicyResultsForHIT -> Int #

ToJSON ListReviewPolicyResultsForHIT Source # 
Instance details

Defined in Amazonka.MechanicalTurk.ListReviewPolicyResultsForHIT

Methods

toJSON :: ListReviewPolicyResultsForHIT -> Value #

toEncoding :: ListReviewPolicyResultsForHIT -> Encoding #

toJSONList :: [ListReviewPolicyResultsForHIT] -> Value #

toEncodingList :: [ListReviewPolicyResultsForHIT] -> Encoding #

AWSRequest ListReviewPolicyResultsForHIT Source # 
Instance details

Defined in Amazonka.MechanicalTurk.ListReviewPolicyResultsForHIT

Associated Types

type AWSResponse ListReviewPolicyResultsForHIT #

Methods

request :: ListReviewPolicyResultsForHIT -> Request ListReviewPolicyResultsForHIT #

response :: MonadResource m => Logger -> Service -> Proxy ListReviewPolicyResultsForHIT -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListReviewPolicyResultsForHIT))) #

ToHeaders ListReviewPolicyResultsForHIT Source # 
Instance details

Defined in Amazonka.MechanicalTurk.ListReviewPolicyResultsForHIT

Methods

toHeaders :: ListReviewPolicyResultsForHIT -> [Header] #

ToPath ListReviewPolicyResultsForHIT Source # 
Instance details

Defined in Amazonka.MechanicalTurk.ListReviewPolicyResultsForHIT

Methods

toPath :: ListReviewPolicyResultsForHIT -> ByteString #

ToQuery ListReviewPolicyResultsForHIT Source # 
Instance details

Defined in Amazonka.MechanicalTurk.ListReviewPolicyResultsForHIT

Methods

toQuery :: ListReviewPolicyResultsForHIT -> QueryString #

type Rep ListReviewPolicyResultsForHIT Source # 
Instance details

Defined in Amazonka.MechanicalTurk.ListReviewPolicyResultsForHIT

type Rep ListReviewPolicyResultsForHIT = D1 ('MetaData "ListReviewPolicyResultsForHIT" "Amazonka.MechanicalTurk.ListReviewPolicyResultsForHIT" "libZSservicesZSamazonka-mechanicalturkZSamazonka-mechanicalturk" 'False) (C1 ('MetaCons "ListReviewPolicyResultsForHIT'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "retrieveResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: (S1 ('MetaSel ('Just "policyLevels") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ReviewPolicyLevel])) :*: S1 ('MetaSel ('Just "retrieveActions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "hITId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))
type AWSResponse ListReviewPolicyResultsForHIT Source # 
Instance details

Defined in Amazonka.MechanicalTurk.ListReviewPolicyResultsForHIT

type AWSResponse ListReviewPolicyResultsForHIT = ListReviewPolicyResultsForHITResponse

newListReviewPolicyResultsForHIT Source #

Arguments

:: Text

$sel:hITId:ListReviewPolicyResultsForHIT'

-> ListReviewPolicyResultsForHIT 

Create a value of ListReviewPolicyResultsForHIT 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:retrieveResults:ListReviewPolicyResultsForHIT', listReviewPolicyResultsForHIT_retrieveResults - Specify if the operation should retrieve a list of the results computed by the Review Policies.

$sel:policyLevels:ListReviewPolicyResultsForHIT', listReviewPolicyResultsForHIT_policyLevels - The Policy Level(s) to retrieve review results for - HIT or Assignment. If omitted, the default behavior is to retrieve all data for both policy levels. For a list of all the described policies, see Review Policies.

$sel:retrieveActions:ListReviewPolicyResultsForHIT', listReviewPolicyResultsForHIT_retrieveActions - Specify if the operation should retrieve a list of the actions taken executing the Review Policies and their outcomes.

$sel:nextToken:ListReviewPolicyResultsForHIT', listReviewPolicyResultsForHIT_nextToken - Pagination token

$sel:maxResults:ListReviewPolicyResultsForHIT', listReviewPolicyResultsForHIT_maxResults - Limit the number of results returned.

$sel:hITId:ListReviewPolicyResultsForHIT', listReviewPolicyResultsForHIT_hITId - The unique identifier of the HIT to retrieve review results for.

Request Lenses

listReviewPolicyResultsForHIT_retrieveResults :: Lens' ListReviewPolicyResultsForHIT (Maybe Bool) Source #

Specify if the operation should retrieve a list of the results computed by the Review Policies.

listReviewPolicyResultsForHIT_policyLevels :: Lens' ListReviewPolicyResultsForHIT (Maybe [ReviewPolicyLevel]) Source #

The Policy Level(s) to retrieve review results for - HIT or Assignment. If omitted, the default behavior is to retrieve all data for both policy levels. For a list of all the described policies, see Review Policies.

listReviewPolicyResultsForHIT_retrieveActions :: Lens' ListReviewPolicyResultsForHIT (Maybe Bool) Source #

Specify if the operation should retrieve a list of the actions taken executing the Review Policies and their outcomes.

listReviewPolicyResultsForHIT_nextToken :: Lens' ListReviewPolicyResultsForHIT (Maybe Text) Source #

Pagination token

listReviewPolicyResultsForHIT_maxResults :: Lens' ListReviewPolicyResultsForHIT (Maybe Natural) Source #

Limit the number of results returned.

listReviewPolicyResultsForHIT_hITId :: Lens' ListReviewPolicyResultsForHIT Text Source #

The unique identifier of the HIT to retrieve review results for.

Destructuring the Response

data ListReviewPolicyResultsForHITResponse Source #

See: newListReviewPolicyResultsForHITResponse smart constructor.

Constructors

ListReviewPolicyResultsForHITResponse' 

Fields

Instances

Instances details
Eq ListReviewPolicyResultsForHITResponse Source # 
Instance details

Defined in Amazonka.MechanicalTurk.ListReviewPolicyResultsForHIT

Methods

(==) :: ListReviewPolicyResultsForHITResponse -> ListReviewPolicyResultsForHITResponse -> Bool #

(/=) :: ListReviewPolicyResultsForHITResponse -> ListReviewPolicyResultsForHITResponse -> Bool #

Read ListReviewPolicyResultsForHITResponse Source # 
Instance details

Defined in Amazonka.MechanicalTurk.ListReviewPolicyResultsForHIT

Methods

readsPrec :: Int -> ReadS ListReviewPolicyResultsForHITResponse #

readList :: ReadS [ListReviewPolicyResultsForHITResponse] #

readPrec :: ReadPrec ListReviewPolicyResultsForHITResponse #

readListPrec :: ReadPrec [ListReviewPolicyResultsForHITResponse] #

Show ListReviewPolicyResultsForHITResponse Source # 
Instance details

Defined in Amazonka.MechanicalTurk.ListReviewPolicyResultsForHIT

Methods

showsPrec :: Int -> ListReviewPolicyResultsForHITResponse -> ShowS #

show :: ListReviewPolicyResultsForHITResponse -> String #

showList :: [ListReviewPolicyResultsForHITResponse] -> ShowS #

Generic ListReviewPolicyResultsForHITResponse Source # 
Instance details

Defined in Amazonka.MechanicalTurk.ListReviewPolicyResultsForHIT

Associated Types

type Rep ListReviewPolicyResultsForHITResponse :: Type -> Type #

Methods

from :: ListReviewPolicyResultsForHITResponse -> Rep ListReviewPolicyResultsForHITResponse x #

to :: Rep ListReviewPolicyResultsForHITResponse x -> ListReviewPolicyResultsForHITResponse #

NFData ListReviewPolicyResultsForHITResponse Source # 
Instance details

Defined in Amazonka.MechanicalTurk.ListReviewPolicyResultsForHIT

Methods

rnf :: ListReviewPolicyResultsForHITResponse -> () #

type Rep ListReviewPolicyResultsForHITResponse Source # 
Instance details

Defined in Amazonka.MechanicalTurk.ListReviewPolicyResultsForHIT

type Rep ListReviewPolicyResultsForHITResponse = D1 ('MetaData "ListReviewPolicyResultsForHITResponse" "Amazonka.MechanicalTurk.ListReviewPolicyResultsForHIT" "libZSservicesZSamazonka-mechanicalturkZSamazonka-mechanicalturk" 'False) (C1 ('MetaCons "ListReviewPolicyResultsForHITResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "hITReviewPolicy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ReviewPolicy)) :*: (S1 ('MetaSel ('Just "hITReviewReport") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ReviewReport)) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "assignmentReviewReport") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ReviewReport)) :*: S1 ('MetaSel ('Just "hITId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "assignmentReviewPolicy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ReviewPolicy)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newListReviewPolicyResultsForHITResponse Source #

Arguments

:: Int

$sel:httpStatus:ListReviewPolicyResultsForHITResponse'

-> ListReviewPolicyResultsForHITResponse 

Create a value of ListReviewPolicyResultsForHITResponse 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:hITReviewPolicy:ListReviewPolicyResultsForHITResponse', listReviewPolicyResultsForHITResponse_hITReviewPolicy - The name of the HIT-level Review Policy. This contains only the PolicyName element.

$sel:hITReviewReport:ListReviewPolicyResultsForHITResponse', listReviewPolicyResultsForHITResponse_hITReviewReport - Contains both ReviewResult and ReviewAction elements for a particular HIT.

$sel:nextToken:ListReviewPolicyResultsForHIT', listReviewPolicyResultsForHITResponse_nextToken - Undocumented member.

$sel:assignmentReviewReport:ListReviewPolicyResultsForHITResponse', listReviewPolicyResultsForHITResponse_assignmentReviewReport - Contains both ReviewResult and ReviewAction elements for an Assignment.

$sel:hITId:ListReviewPolicyResultsForHIT', listReviewPolicyResultsForHITResponse_hITId - The HITId of the HIT for which results have been returned.

$sel:assignmentReviewPolicy:ListReviewPolicyResultsForHITResponse', listReviewPolicyResultsForHITResponse_assignmentReviewPolicy - The name of the Assignment-level Review Policy. This contains only the PolicyName element.

$sel:httpStatus:ListReviewPolicyResultsForHITResponse', listReviewPolicyResultsForHITResponse_httpStatus - The response's http status code.

Response Lenses

listReviewPolicyResultsForHITResponse_hITReviewPolicy :: Lens' ListReviewPolicyResultsForHITResponse (Maybe ReviewPolicy) Source #

The name of the HIT-level Review Policy. This contains only the PolicyName element.

listReviewPolicyResultsForHITResponse_hITReviewReport :: Lens' ListReviewPolicyResultsForHITResponse (Maybe ReviewReport) Source #

Contains both ReviewResult and ReviewAction elements for a particular HIT.

listReviewPolicyResultsForHITResponse_nextToken :: Lens' ListReviewPolicyResultsForHITResponse (Maybe Text) Source #

Undocumented member.

listReviewPolicyResultsForHITResponse_assignmentReviewReport :: Lens' ListReviewPolicyResultsForHITResponse (Maybe ReviewReport) Source #

Contains both ReviewResult and ReviewAction elements for an Assignment.

listReviewPolicyResultsForHITResponse_hITId :: Lens' ListReviewPolicyResultsForHITResponse (Maybe Text) Source #

The HITId of the HIT for which results have been returned.

listReviewPolicyResultsForHITResponse_assignmentReviewPolicy :: Lens' ListReviewPolicyResultsForHITResponse (Maybe ReviewPolicy) Source #

The name of the Assignment-level Review Policy. This contains only the PolicyName element.

listReviewPolicyResultsForHITResponse_httpStatus :: Lens' ListReviewPolicyResultsForHITResponse Int Source #

The response's http status code.