- Navigation GuideYou are on a Client landing page. Commands (operations) are listed on this page. The Client constructor type is linked at the bottom.
MTurkClient
Installation
npm install @aws-sdk/client-mturk
yarn add @aws-sdk/client-mturk
pnpm add @aws-sdk/client-mturk
MTurkClient Operations
Command | Summary |
---|
Command | Summary |
---|---|
AcceptQualificationRequestCommand | The Only the owner of the Qualification type can grant a Qualification request for that type. A successful request for the |
ApproveAssignmentCommand | The Approving an assignment initiates two payments from the Requester's Amazon.com account
If the Requester's account does not have adequate funds for these payments, the call to ApproveAssignment returns an exception, and the approval is not processed. You can include an optional feedback message with the approval, which the Worker can see in the Status section of the web site. You can also call this operation for assignments that were previous rejected and approve them by explicitly overriding the previous rejection. This only works on rejected assignments that were submitted within the previous 30 days and only if the assignment's related HIT has not been deleted. |
AssociateQualificationWithWorkerCommand | The You can only assign a Qualification of a Qualification type that you created (using the Note: |
CreateAdditionalAssignmentsForHITCommand | The To extend the maximum number of assignments, specify the number of additional assignments.
|
CreateHITCommand | The This operation allows you to specify a new HIT by passing in values for the properties of the HIT, such as its title, reward amount and number of assignments. When you pass these values to An alternative way to create HITs is to first generate a HITTypeID using the CreateHIT also supports several ways to provide question data: by providing a value for the If a HIT is created with 10 or more maximum assignments, there is an additional fee. For more information, see Amazon Mechanical Turk Pricing . |
CreateHITTypeCommand | The |
CreateHITWithHITTypeCommand | The This is an alternative way to create HITs from the CreateHITWithHITType also supports several ways to provide question data: by providing a value for the If a HIT is created with 10 or more maximum assignments, there is an additional fee. For more information, see Amazon Mechanical Turk Pricing . |
CreateQualificationTypeCommand | The |
CreateWorkerBlockCommand | The |
DeleteHITCommand | The You can only dispose of HITs that are in the
|
DeleteQualificationTypeCommand | The 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 delete a Qualification type, you can no longer use it to create HITs or HIT types. DeleteQualificationType must wait for all the HITs that use the deleted Qualification type to be deleted before completing. It may take up to 48 hours before DeleteQualificationType completes and the unique name of the Qualification type is available for reuse with CreateQualificationType. |
DeleteWorkerBlockCommand | The |
DisassociateQualificationFromWorkerCommand | The You can provide a text message explaining why the Qualification was revoked. The user who had the Qualification can see this message. |
GetAccountBalanceCommand | The |
GetAssignmentCommand | The |
GetFileUploadURLCommand | The |
GetHITCommand | The |
GetQualificationScoreCommand | The To get a Worker's Qualification, you must know the Worker's ID. The Worker's ID is included in the assignment data returned by the Only the owner of a Qualification type can query the value of a Worker's Qualification of that type. |
GetQualificationTypeCommand | The |
ListAssignmentsForHITCommand | The You can get assignments for a HIT at any time, even if the HIT is not yet Reviewable. If a HIT requested multiple assignments, and has received some results but has not yet become Reviewable, you can still retrieve the partial results with this operation. Use the AssignmentStatus parameter to control which set of assignments for a HIT are returned. The ListAssignmentsForHIT operation can return submitted assignments awaiting approval, or it can return assignments that have already been approved or rejected. You can set AssignmentStatus=Approved,Rejected to get assignments that have already been approved and rejected together in one result set. Only the Requester who created the HIT can retrieve the assignments for that HIT. Results are sorted and divided into numbered pages and the operation returns a single page of results. You can use the parameters of the operation to control sorting and pagination. |
ListBonusPaymentsCommand | The |
ListHITsCommand | The |
ListHITsForQualificationTypeCommand | The |
ListQualificationRequestsCommand | The |
ListQualificationTypesCommand | The |
ListReviewPolicyResultsForHITCommand | The |
ListReviewableHITsCommand | The |
ListWorkerBlocksCommand | The |
ListWorkersWithQualificationTypeCommand | The |
NotifyWorkersCommand | The |
RejectAssignmentCommand | The 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. |
RejectQualificationRequestCommand | The You can provide a text message explaining why the request was rejected. The Worker who made the request can see this message. |
SendBonusCommand | The |
SendTestEventNotificationCommand | The |
UpdateExpirationForHITCommand | The |
UpdateHITReviewStatusCommand | The |
UpdateHITTypeOfHITCommand | The |
UpdateNotificationSettingsCommand | The |
UpdateQualificationTypeCommand | The Most attributes of a Qualification type can be changed after the type has been created. However, the Name and Keywords fields cannot be modified. The RetryDelayInSeconds parameter can be modified or added to change the delay or to enable retries, but RetryDelayInSeconds cannot be used to disable retries. You can use this operation to update the test for a Qualification type. The test is updated based on the values specified for the Test, TestDurationInSeconds and AnswerKey parameters. All three parameters specify the updated test. If you are updating the test for a type, you must specify the Test and TestDurationInSeconds parameters. The AnswerKey parameter is optional; omitting it specifies that the updated test does not have an answer key. If you omit the Test parameter, the test for the Qualification type is unchanged. There is no way to remove a test from a Qualification type that has one. If the type already has a test, you cannot update it to be AutoGranted. If the Qualification type does not have a test and one is provided by an update, the type will henceforth have a test. If you want to update the test duration or answer key for an existing test without changing the questions, you must specify a Test parameter with the original questions, along with the updated values. If you provide an updated Test but no AnswerKey, the new test will not have an answer key. Requests for such Qualifications must be granted manually. You can also update the AutoGranted and AutoGrantedValue attributes of the Qualification type. |
MTurkClient Configuration
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
defaultsMode Optional | DefaultsMode | Provider<DefaultsMode> | The @smithy/smithy-client#DefaultsMode that will be used to determine how certain default configuration options are resolved in the SDK. |
disableHostPrefix Optional | boolean | Disable dynamically changing the endpoint of the client based on the hostPrefix trait of an operation. |
extensions Optional | RuntimeExtension[] | Optional extensions |
logger Optional | Logger | Optional logger for logging debug/info/warn/error. |
maxAttempts Optional | number | Provider<number> | Value for how many times a request will be made at most in case of retry. |
profile Optional | string | Setting a client profile is similar to setting a value for the AWS_PROFILE environment variable. Setting a profile on a client in code only affects the single client instance, unlike AWS_PROFILE.When set, and only for environments where an AWS configuration file exists, fields configurable by this file will be retrieved from the specified profile within that file. Conflicting code configuration and environment variables will still have higher priority.For client credential resolution that involves checking the AWS configuration file, the client's profile (this value) will be used unless a different profile is set in the credential provider options. |
region Optional | string | Provider<string> | The AWS region to which this client will send requests |
requestHandler Optional | __HttpHandlerUserInput | The HTTP handler to use or its constructor options. Fetch in browser and Https in Nodejs. |
retryMode Optional | string | Provider<string> | Specifies which retry algorithm to use. |
useDualstackEndpoint Optional | boolean | Provider<boolean> | Enables IPv6/IPv4 dualstack endpoint. |
useFipsEndpoint Optional | boolean | Provider<boolean> | Enables FIPS compatible endpoints. |
Additional config fields are described in the full configuration type: MTurkClientConfig