DisposeQualificationType - Amazon Mechanical Turk

WARNING

You are browsing the documentation for a deprecated version ('2014-08-15') of the Amazon Mechanical Turk Requester API. This version of the API will be deprecated and will be rendered unusable as of June 1st, 2019.

If you request against a legacy API version (https://docs.aws.amazon.com/AWSMechTurk/latest/AWSMturkAPI-legacy/Welcome.html) on or after June 1, 2019, you will receive the following response:

This Requester API is no longer supported. Please use the latest API using the official AWS SDK. https://aws.amazon.com/getting-started/tools-sdks

The latest version of our API ('2017-01-17') provides you with additional tool choices and enables you to select from nine AWS Software Development Kits (SDKs) that have been widely adopted across the AWS community. This API can be accessed using the following AWS SDKs: Python/Boto (Boto3), Javascript (NodeJS or Browser), Java, .NET, Go, Ruby, PHP or C++. This version also makes it easier for customers to connect MTurk with other AWS services like S3, Lambda, Step Functions, Lex, Polly, Rekognition, Amazon SageMaker, AWS Batch, EC2, and more.

This version also updates naming conventions used in the API and adopts the AWS standard of Signature Version 4 to authenticate requests securely. The API uses REST requests and no longer requires that developers be familiar with SOAP protocol. These changes make the MTurk API consistent with AWS APIs, simplifying the on-boarding process for both new and existing AWS developers. The legacy MTurk Command Line Tools and .NET, Java, Ruby, and Perl SDKs were marked as deprecated in January 2018. We will be deprecating the legacy APIs as of June 1, 2019.

If you are on a legacy API, you must migrate to the latest version of our API. You can find documentation for the latest API here and the AWS SDKs here. Please check whether you need to migrate and review the technical migration guide.

For support, contact requestor-apilegacydeprecation-support@amazon.com.

 

DisposeQualificationType

Description

The DisposeQualificationType operation disposes a Qualification type and disposes any HIT types that are associated with the Qualification type. A Qualification type is represented by a QualificationType data structure.

This operation does not revoke Qualifications already assigned to Workers because the Qualifications might be needed for active HITs. If there are any pending requests for the Qualification type, Amazon Mechanical Turk rejects those requests.

After you dispose of a Qualification type, you can no longer use it to create HITs or HIT types.

Note

DisposeQualificationType must wait for all the HITs that use the disposed Qualification type to be disposed before completing. It may take up to 48 hours before DisposeQualificationType completes and the unique name of the disposed Qualification type is available for reuse with CreateQualificationType.

Request Parameters

A request to the Amazon Mechanical Turk Service includes parameters that control its behavior and the data it returns. Required parameters must be included for the request to succeed.

DisposeQualificationType accepts parameters common to all operations. Some common parameters are required. See Common Parameters for more information.

The following parameters are specific to the DisposeQualificationType operation:

Name Description Required
Operation

The operation you want to call. To access the DisposeQualificationType operation, set the Operation parameter to DisposeQualificationType.

Type: DisposeQualificationType

Default: None

Yes

QualificationTypeId

The ID of the QualificationType to dispose.

Type: String

Default: None

Constraint: A valid QualificationType ID.

Yes

Response Elements

A successful request for the DisposeQualificationType operation returns with no errors. The response includes the elements described in the following table. The operation returns no other data.

Name Description

DisposeQualificationTypeResult

Contains a Request element if the Request ResponseGroup is specified.

Examples

The following example shows how to use the DisposeQualification operation.

Sample Request

The following example disposes a Qualification type and any HIT types that are associated with the Qualification type.

https://mechanicalturk.amazonaws.com/?Service=AWSMechanicalTurkRequester &AWSAccessKeyId=[the Requester's Access Key ID] &Version=2017-01-17 &Operation=DisposeQualificationType &Signature=[signature for this request] &Timestamp=[your system's local time] &QualificationTypeId=AZ34EXAMPLE

Sample Response

The following is an example response.

<DisposeQualificationTypeResult> <Request> <IsValid>True</IsValid> </Request> </DisposeQualificationTypeResult>