worker_blocks

Creates, updates, deletes, gets or lists a worker_blocks resource.

Overview

Name	worker_blocks
Type	Resource
Id	aws.mturk.worker_blocks

Fields

The following fields are returned by SELECT queries:

list_worker_blocks

Name	Datatype	Description
reason	string	A message explaining the reason the Worker was blocked.
worker_id	string	The ID of the Worker who accepted the HIT. (pattern: <code>^A[A-Z0-9]+$</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_worker_blocks	select	region		The ListWorkersBlocks operation retrieves a list of Workers who are blocked from working on your HITs.
create_worker_block	insert	region, WorkerId		The CreateWorkerBlock operation allows you to prevent a Worker from working on your HITs. For example, you can block a Worker who is producing poor quality work. You can block up to 100,000 Workers.
delete_worker_block	delete	region		The DeleteWorkerBlock operation allows you to reinstate a blocked Worker to work on your HITs. This operation reverses the effects of the CreateWorkerBlock operation. You need the Worker ID to use this operation. If the Worker ID is missing or invalid, this operation fails and returns the message “WorkerId is invalid.” If the specified Worker is not blocked, this operation returns successfully.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

list_worker_blocks

The ListWorkersBlocks operation retrieves a list of Workers who are blocked from working on your HITs.

SELECT
reason,
worker_id
FROM aws.mturk.worker_blocks
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_worker_block

The CreateWorkerBlock operation allows you to prevent a Worker from working on your HITs. For example, you can block a Worker who is producing poor quality work. You can block up to 100,000 Workers.

INSERT INTO aws.mturk.worker_blocks (
WorkerId,
Reason,
region
)
SELECT 
'{{ WorkerId }}' /* required */,
'{{ Reason }}',
'{{ region }}'
;

Manifest

# Description fields are for documentation purposes
- name: worker_blocks
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the worker_blocks resource.
  - name: WorkerId
    value: "{{ WorkerId }}"
    description: |
      The ID of the Worker to block.
  - name: Reason
    value: "{{ Reason }}"
    description: |
      A message explaining the reason for blocking the Worker. This parameter enables you to keep track of your Workers. The Worker does not see this message.

DELETE examples

delete_worker_block

The DeleteWorkerBlock operation allows you to reinstate a blocked Worker to work on your HITs. This operation reverses the effects of the CreateWorkerBlock operation. You need the Worker ID to use this operation. If the Worker ID is missing or invalid, this operation fails and returns the message “WorkerId is invalid.” If the specified Worker is not blocked, this operation returns successfully.

DELETE FROM aws.mturk.worker_blocks
WHERE region = '{{ region }}' --required
;