MTurk / Client / list_workers_with_qualification_type

list_workers_with_qualification_type#

MTurk.Client.list_workers_with_qualification_type(**kwargs)#

The ListWorkersWithQualificationType operation returns all of the Workers that have been associated with a given Qualification type.

See also: AWS API Documentation

Request Syntax

response = client.list_workers_with_qualification_type(
    QualificationTypeId='string',
    Status='Granted'|'Revoked',
    NextToken='string',
    MaxResults=123
)
Parameters:

  • QualificationTypeId (string) –

    [REQUIRED]

    The ID of the Qualification type of the Qualifications to return.

  • Status (string) – The status of the Qualifications to return. Can be Granted | Revoked.

  • NextToken (string) – Pagination Token

  • MaxResults (integer) – Limit the number of results returned.

Return type:

dict

Returns:

Response Syntax

{
    'NextToken': 'string',
    'NumResults': 123,
    'Qualifications': [
        {
            'QualificationTypeId': 'string',
            'WorkerId': 'string',
            'GrantTime': datetime(2015, 1, 1),
            'IntegerValue': 123,
            'LocaleValue': {
                'Country': 'string',
                'Subdivision': 'string'
            },
            'Status': 'Granted'|'Revoked'
        },
    ]
}

Response Structure

  • (dict) –

    • NextToken (string) –

      If the previous response was incomplete (because there is more data to retrieve), Amazon Mechanical Turk returns a pagination token in the response. You can use this pagination token to retrieve the next set of results.

    • NumResults (integer) –

      The number of Qualifications on this page in the filtered results list, equivalent to the number of Qualifications being returned by this call.

    • Qualifications (list) –

      The list of Qualification elements returned by this call.

      • (dict) –

        The Qualification data structure represents a Qualification assigned to a user, including the Qualification type and the value (score).

        • QualificationTypeId (string) –

          The ID of the Qualification type for the Qualification.

        • WorkerId (string) –

          The ID of the Worker who possesses the Qualification.

        • GrantTime (datetime) –

          The date and time the Qualification was granted to the Worker. If the Worker’s Qualification was revoked, and then re-granted based on a new Qualification request, GrantTime is the date and time of the last call to the AcceptQualificationRequest operation.

        • IntegerValue (integer) –

          The value (score) of the Qualification, if the Qualification has an integer value.

        • LocaleValue (dict) –

          The Locale data structure represents a geographical region or location.

          • Country (string) –

            The country of the locale. Must be a valid ISO 3166 country code. For example, the code US refers to the United States of America.

          • Subdivision (string) –

            The state or subdivision of the locale. A valid ISO 3166-2 subdivision code. For example, the code WA refers to the state of Washington.

        • Status (string) –

          The status of the Qualification. Valid values are Granted | Revoked.

Exceptions