Amazon Mechanical Turk¶

Description¶

Amazon Mechanical Turk API Reference

Usage¶

mturk(config = list(), credentials = list(), endpoint = NULL, region = NULL)

Arguments¶

config

Optional configuration of credentials, endpoint, and/or region.
- credentials:
  - creds:
    - access_key_id: AWS access key ID
    - secret_access_key: AWS secret access key
    - session_token: AWS temporary session token
  - profile: The name of a profile to use. If not given, then the default profile is used.
  - anonymous: Set anonymous credentials.
- endpoint: The complete URL to use for the constructed client.
- region: The AWS Region used in instantiating the client.
- close_connection: Immediately close all HTTP connections.
- timeout: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.
- s3_force_path_style: Set this to true to force the request to use path-style addressing, i.e. http://s3.amazonaws.com/BUCKET/KEY.
- sts_regional_endpoint: Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html
- use_dual_stack: Set this to true to use the dualstack (IPv4 and IPv6) endpoint for a service, where available, falling back to the regular endpoint when it isn't. Defaults to the AWS_USE_DUALSTACK_ENDPOINT environment variable when unset.
credentials

Optional credentials shorthand for the config parameter
- creds:
  - access_key_id: AWS access key ID
  - secret_access_key: AWS secret access key
  - session_token: AWS temporary session token
- profile: The name of a profile to use. If not given, then the default profile is used.
- anonymous: Set anonymous credentials.
endpoint

Optional shorthand for complete URL to use for the constructed client.
region

Optional shorthand for AWS Region used in instantiating the client.

Value¶

A client for the service. You can call the service's operations using syntax like svc$operation(...), where svc is the name you've assigned to the client. The available operations are listed in the Operations section.

Service syntax¶

svc <- mturk(
  config = list(
    credentials = list(
      creds = list(
        access_key_id = "string",
        secret_access_key = "string",
        session_token = "string"
      ),
      profile = "string",
      anonymous = "logical"
    ),
    endpoint = "string",
    region = "string",
    close_connection = "logical",
    timeout = "numeric",
    s3_force_path_style = "logical",
    sts_regional_endpoint = "string",
    use_dual_stack = "logical"
  ),
  credentials = list(
    creds = list(
      access_key_id = "string",
      secret_access_key = "string",
      session_token = "string"
    ),
    profile = "string",
    anonymous = "logical"
  ),
  endpoint = "string",
  region = "string"
)

Operations¶

`accept_qualification_request`	The AcceptQualificationRequest operation approves a Worker's request for a Qualification
`approve_assignment`	The ApproveAssignment operation approves the results of a completed assignment
`associate_qualification_with_worker`	The AssociateQualificationWithWorker operation gives a Worker a Qualification
`create_additional_assignments_for_hit`	The CreateAdditionalAssignmentsForHIT operation increases the maximum number of assignments of an existing HIT
`create_hit`	The CreateHIT operation creates a new Human Intelligence Task (HIT)
`create_hit_type`	The CreateHITType operation creates a new HIT type
`create_hit_with_hit_type`	The CreateHITWithHITType operation creates a new Human Intelligence Task (HIT) using an existing HITTypeID generated by the CreateHITType operation
`create_qualification_type`	The CreateQualificationType operation creates a new Qualification type, which is represented by a QualificationType data structure
`create_worker_block`	The CreateWorkerBlock operation allows you to prevent a Worker from working on your HITs
`delete_hit`	The DeleteHIT operation is used to delete HIT that is no longer needed
`delete_qualification_type`	The DeleteQualificationType deletes a Qualification type and deletes any HIT types that are associated with the Qualification type
`delete_worker_block`	The DeleteWorkerBlock operation allows you to reinstate a blocked Worker to work on your HITs
`disassociate_qualification_from_worker`	The DisassociateQualificationFromWorker revokes a previously granted Qualification from a user
`get_account_balance`	The GetAccountBalance operation retrieves the Prepaid HITs balance in your Amazon Mechanical Turk account if you are a Prepaid Requester
`get_assignment`	The GetAssignment operation retrieves the details of the specified Assignment
`get_file_upload_url`	The GetFileUploadURL operation generates and returns a temporary URL
`get_hit`	The GetHIT operation retrieves the details of the specified HIT
`get_qualification_score`	The GetQualificationScore operation returns the value of a Worker's Qualification for a given Qualification type
`get_qualification_type`	The GetQualificationTypeoperation retrieves information about a Qualification type using its ID
`list_assignments_for_hit`	The ListAssignmentsForHIT operation retrieves completed assignments for a HIT
`list_bonus_payments`	The ListBonusPayments operation retrieves the amounts of bonuses you have paid to Workers for a given HIT or assignment
`list_hi_ts`	The ListHITs operation returns all of a Requester's HITs
`list_hi_ts_for_qualification_type`	The ListHITsForQualificationType operation returns the HITs that use the given Qualification type for a Qualification requirement
`list_qualification_requests`	The ListQualificationRequests operation retrieves requests for Qualifications of a particular Qualification type
`list_qualification_types`	The ListQualificationTypes operation returns a list of Qualification types, filtered by an optional search term
`list_reviewable_hi_ts`	The ListReviewableHITs operation retrieves the HITs with Status equal to Reviewable or Status equal to Reviewing that belong to the Requester calling the operation
`list_review_policy_results_for_hit`	The ListReviewPolicyResultsForHIT operation retrieves the computed results and the actions taken in the course of executing your Review Policies for a given HIT
`list_worker_blocks`	The ListWorkersBlocks operation retrieves a list of Workers who are blocked from working on your HITs
`list_workers_with_qualification_type`	The ListWorkersWithQualificationType operation returns all of the Workers that have been associated with a given Qualification type
`notify_workers`	The NotifyWorkers operation sends an email to one or more Workers that you specify with the Worker ID
`reject_assignment`	The RejectAssignment operation rejects the results of a completed assignment
`reject_qualification_request`	The RejectQualificationRequest operation rejects a user's request for a Qualification
`send_bonus`	The SendBonus operation issues a payment of money from your account to a Worker
`send_test_event_notification`	The SendTestEventNotification operation causes Amazon Mechanical Turk to send a notification message as if a HIT event occurred, according to the provided notification specification
`update_expiration_for_hit`	The UpdateExpirationForHIT operation allows you update the expiration time of a HIT
`update_hit_review_status`	The UpdateHITReviewStatus operation updates the status of a HIT
`update_hit_type_of_hit`	The UpdateHITTypeOfHIT operation allows you to change the HITType properties of a HIT
`update_notification_settings`	The UpdateNotificationSettings operation creates, updates, disables or re-enables notifications for a HIT type
`update_qualification_type`	The UpdateQualificationType operation modifies the attributes of an existing Qualification type, which is represented by a QualificationType data structure

Examples¶

svc <- mturk()
svc$accept_qualification_request(
  Foo = 123
)