| 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.ListQualificationTypes
Description
The ListQualificationTypes operation returns a list of Qualification
types, filtered by an optional search term.
This operation returns paginated results.
Synopsis
- data ListQualificationTypes = ListQualificationTypes' {}
- newListQualificationTypes :: Bool -> ListQualificationTypes
- listQualificationTypes_maxResults :: Lens' ListQualificationTypes (Maybe Natural)
- listQualificationTypes_mustBeOwnedByCaller :: Lens' ListQualificationTypes (Maybe Bool)
- listQualificationTypes_nextToken :: Lens' ListQualificationTypes (Maybe Text)
- listQualificationTypes_query :: Lens' ListQualificationTypes (Maybe Text)
- listQualificationTypes_mustBeRequestable :: Lens' ListQualificationTypes Bool
- data ListQualificationTypesResponse = ListQualificationTypesResponse' {}
- newListQualificationTypesResponse :: Int -> ListQualificationTypesResponse
- listQualificationTypesResponse_nextToken :: Lens' ListQualificationTypesResponse (Maybe Text)
- listQualificationTypesResponse_numResults :: Lens' ListQualificationTypesResponse (Maybe Int)
- listQualificationTypesResponse_qualificationTypes :: Lens' ListQualificationTypesResponse (Maybe [QualificationType])
- listQualificationTypesResponse_httpStatus :: Lens' ListQualificationTypesResponse Int
Creating a Request
data ListQualificationTypes Source #
See: newListQualificationTypes smart constructor.
Constructors
| ListQualificationTypes' | |
Fields
| |
Instances
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:maxResults:ListQualificationTypes', listQualificationTypes_maxResults - The maximum number of results to return in a single call.
$sel:mustBeOwnedByCaller:ListQualificationTypes', listQualificationTypes_mustBeOwnedByCaller - Specifies that only Qualification types that the Requester created are
returned. If false, the operation returns all Qualification types.
ListQualificationTypes, listQualificationTypes_nextToken - Undocumented member.
$sel:query:ListQualificationTypes', listQualificationTypes_query - A text query against all of the searchable attributes of Qualification
types.
$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_maxResults :: Lens' ListQualificationTypes (Maybe Natural) Source #
The maximum number of results to return in a single call.
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_nextToken :: Lens' ListQualificationTypes (Maybe Text) Source #
Undocumented member.
listQualificationTypes_query :: Lens' ListQualificationTypes (Maybe Text) Source #
A text query against all of the searchable attributes of Qualification types.
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
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:
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:qualificationTypes:ListQualificationTypesResponse', listQualificationTypesResponse_qualificationTypes - The list of QualificationType elements returned by the query.
$sel:httpStatus:ListQualificationTypesResponse', listQualificationTypesResponse_httpStatus - The response's http status code.
Response Lenses
listQualificationTypesResponse_nextToken :: Lens' ListQualificationTypesResponse (Maybe Text) Source #
Undocumented member.
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.
listQualificationTypesResponse_qualificationTypes :: Lens' ListQualificationTypesResponse (Maybe [QualificationType]) Source #
The list of QualificationType elements returned by the query.
listQualificationTypesResponse_httpStatus :: Lens' ListQualificationTypesResponse Int Source #
The response's http status code.