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

 

RejectAssignment

Description

The RejectAssignment operation rejects the results of a completed assignment.

You can include an optional feedback message with the rejection, which the Worker can see in the Status section of the web site. When you include a feedback message with the rejection, it helps the Worker understand why the assignment was rejected, and can improve the quality of the results the Worker submits in the future.

Only the Requester who created the HIT can reject an assignment for the HIT.

Request Parameters

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

The following parameters are specific to the RejectAssignment operation:

Name Description Required

Operation

The name of the operation

Type: String

Valid Values: RejectAssignment

Default: None

Yes

AssignmentId

The assignment ID

Type: String

Default: None

Yes

RequesterFeedback

A message for the Worker, which the Worker can see in the Status section of the web site.

Type: String

Default: None

Constraints: can be up to 1024 characters, including multi-byte characters.

No

Response Elements

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

Name Description

RejectAssignmentResult

Contains a Request element if the Request ResponseGroup is specified.

Examples

The following example shows how to use the RejectAssignment operation.

Sample Request

The following example rejects an assignment identified by its assignment ID.

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

Sample Response

The following is an example response.

<RejectAssignmentResult> <Request> <IsValid>True</IsValid> </Request> </RejectAssignmentResult>