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

Description

The ListQualificationTypes operation returns a list of Qualification types, filtered by an optional search term.

This operation returns paginated results.

Synopsis

Creating a Request

data ListQualificationTypes Source #

See: newListQualificationTypes smart constructor.

Constructors

ListQualificationTypes' 

Fields

  • mustBeOwnedByCaller :: Maybe Bool

    Specifies that only Qualification types that the Requester created are returned. If false, the operation returns all Qualification types.

  • nextToken :: Maybe Text
     
  • query :: Maybe Text

    A text query against all of the searchable attributes of Qualification types.

  • maxResults :: Maybe Natural

    The maximum number of results to return in a single call.

  • mustBeRequestable :: Bool

    Specifies that only Qualification types that a user can request through the Amazon Mechanical Turk web site, such as by taking a Qualification test, are returned as results of the search. Some Qualification types, such as those assigned automatically by the system, cannot be requested directly by users. If false, all Qualification types, including those managed by the system, are considered. Valid values are True | False.

Instances

Instances details
Eq ListQualificationTypes Source # 
Instance details

Defined in Amazonka.MechanicalTurk.ListQualificationTypes

Read ListQualificationTypes Source # 
Instance details

Defined in Amazonka.MechanicalTurk.ListQualificationTypes

Show ListQualificationTypes Source # 
Instance details

Defined in Amazonka.MechanicalTurk.ListQualificationTypes

Generic ListQualificationTypes Source # 
Instance details

Defined in Amazonka.MechanicalTurk.ListQualificationTypes

Associated Types

type Rep ListQualificationTypes :: Type -> Type #

NFData ListQualificationTypes Source # 
Instance details

Defined in Amazonka.MechanicalTurk.ListQualificationTypes

Methods

rnf :: ListQualificationTypes -> () #

Hashable ListQualificationTypes Source # 
Instance details

Defined in Amazonka.MechanicalTurk.ListQualificationTypes

ToJSON ListQualificationTypes Source # 
Instance details

Defined in Amazonka.MechanicalTurk.ListQualificationTypes

AWSPager ListQualificationTypes Source # 
Instance details

Defined in Amazonka.MechanicalTurk.ListQualificationTypes

AWSRequest ListQualificationTypes Source # 
Instance details

Defined in Amazonka.MechanicalTurk.ListQualificationTypes

Associated Types

type AWSResponse ListQualificationTypes #

ToHeaders ListQualificationTypes Source # 
Instance details

Defined in Amazonka.MechanicalTurk.ListQualificationTypes

ToPath ListQualificationTypes Source # 
Instance details

Defined in Amazonka.MechanicalTurk.ListQualificationTypes

ToQuery ListQualificationTypes Source # 
Instance details

Defined in Amazonka.MechanicalTurk.ListQualificationTypes

type Rep ListQualificationTypes Source # 
Instance details

Defined in Amazonka.MechanicalTurk.ListQualificationTypes

type Rep ListQualificationTypes = D1 ('MetaData "ListQualificationTypes" "Amazonka.MechanicalTurk.ListQualificationTypes" "libZSservicesZSamazonka-mechanicalturkZSamazonka-mechanicalturk" 'False) (C1 ('MetaCons "ListQualificationTypes'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "mustBeOwnedByCaller") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "query") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "mustBeRequestable") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool)))))
type AWSResponse ListQualificationTypes Source # 
Instance details

Defined in Amazonka.MechanicalTurk.ListQualificationTypes

newListQualificationTypes Source #

Create a value of ListQualificationTypes 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:mustBeOwnedByCaller:ListQualificationTypes', listQualificationTypes_mustBeOwnedByCaller - Specifies that only Qualification types that the Requester created are returned. If false, the operation returns all Qualification types.

$sel:nextToken:ListQualificationTypes', listQualificationTypes_nextToken - Undocumented member.

$sel:query:ListQualificationTypes', listQualificationTypes_query - A text query against all of the searchable attributes of Qualification types.

$sel:maxResults:ListQualificationTypes', listQualificationTypes_maxResults - The maximum number of results to return in a single call.

$sel:mustBeRequestable:ListQualificationTypes', listQualificationTypes_mustBeRequestable - Specifies that only Qualification types that a user can request through the Amazon Mechanical Turk web site, such as by taking a Qualification test, are returned as results of the search. Some Qualification types, such as those assigned automatically by the system, cannot be requested directly by users. If false, all Qualification types, including those managed by the system, are considered. Valid values are True | False.

Request Lenses

listQualificationTypes_mustBeOwnedByCaller :: Lens' ListQualificationTypes (Maybe Bool) Source #

Specifies that only Qualification types that the Requester created are returned. If false, the operation returns all Qualification types.

listQualificationTypes_query :: Lens' ListQualificationTypes (Maybe Text) Source #

A text query against all of the searchable attributes of Qualification types.

listQualificationTypes_maxResults :: Lens' ListQualificationTypes (Maybe Natural) Source #

The maximum number of results to return in a single call.

listQualificationTypes_mustBeRequestable :: Lens' ListQualificationTypes Bool Source #

Specifies that only Qualification types that a user can request through the Amazon Mechanical Turk web site, such as by taking a Qualification test, are returned as results of the search. Some Qualification types, such as those assigned automatically by the system, cannot be requested directly by users. If false, all Qualification types, including those managed by the system, are considered. Valid values are True | False.

Destructuring the Response

data ListQualificationTypesResponse Source #

See: newListQualificationTypesResponse smart constructor.

Constructors

ListQualificationTypesResponse' 

Fields

Instances

Instances details
Eq ListQualificationTypesResponse Source # 
Instance details

Defined in Amazonka.MechanicalTurk.ListQualificationTypes

Read ListQualificationTypesResponse Source # 
Instance details

Defined in Amazonka.MechanicalTurk.ListQualificationTypes

Show ListQualificationTypesResponse Source # 
Instance details

Defined in Amazonka.MechanicalTurk.ListQualificationTypes

Generic ListQualificationTypesResponse Source # 
Instance details

Defined in Amazonka.MechanicalTurk.ListQualificationTypes

Associated Types

type Rep ListQualificationTypesResponse :: Type -> Type #

NFData ListQualificationTypesResponse Source # 
Instance details

Defined in Amazonka.MechanicalTurk.ListQualificationTypes

type Rep ListQualificationTypesResponse Source # 
Instance details

Defined in Amazonka.MechanicalTurk.ListQualificationTypes

type Rep ListQualificationTypesResponse = D1 ('MetaData "ListQualificationTypesResponse" "Amazonka.MechanicalTurk.ListQualificationTypes" "libZSservicesZSamazonka-mechanicalturkZSamazonka-mechanicalturk" 'False) (C1 ('MetaCons "ListQualificationTypesResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "qualificationTypes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [QualificationType])) :*: 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))))

newListQualificationTypesResponse Source #

Create a value of ListQualificationTypesResponse 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:qualificationTypes:ListQualificationTypesResponse', listQualificationTypesResponse_qualificationTypes - The list of QualificationType elements returned by the query.

$sel:nextToken:ListQualificationTypes', listQualificationTypesResponse_nextToken - Undocumented member.

$sel:numResults:ListQualificationTypesResponse', listQualificationTypesResponse_numResults - The number of Qualification types on this page in the filtered results list, equivalent to the number of types this operation returns.

$sel:httpStatus:ListQualificationTypesResponse', listQualificationTypesResponse_httpStatus - The response's http status code.

Response Lenses

listQualificationTypesResponse_numResults :: Lens' ListQualificationTypesResponse (Maybe Int) Source #

The number of Qualification types on this page in the filtered results list, equivalent to the number of types this operation returns.