aws-sdk-mturk 1.0.0.rc1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/lib/aws-sdk-mturk.rb +47 -0
- data/lib/aws-sdk-mturk/client.rb +2660 -0
- data/lib/aws-sdk-mturk/client_api.rb +1152 -0
- data/lib/aws-sdk-mturk/customizations.rb +0 -0
- data/lib/aws-sdk-mturk/errors.rb +14 -0
- data/lib/aws-sdk-mturk/resource.rb +23 -0
- data/lib/aws-sdk-mturk/types.rb +3107 -0
- metadata +80 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA1:
|
3
|
+
metadata.gz: 06f7f870903de984f2eb7d36deedb6b65693047b
|
4
|
+
data.tar.gz: 9b21affae7a19326b7bcc5ebe221843c372c8583
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: 3d5999aca902abf7c320df4164dfe90bbc6307767e76101e784954a0f2dc8898a396fe1382d47b9ef85afc0bf92c4386e237997b05a80acfd97c1fea7aa51ab2
|
7
|
+
data.tar.gz: 13e1f728b13fd1b2bcefa8c92bbbb40df546758cfa6bed311ce7d7e350f0cb120679af4dd72411f44ad5befd61d1f49f67dc631bc9eaae5dbfeadc6333407a34
|
@@ -0,0 +1,47 @@
|
|
1
|
+
# WARNING ABOUT GENERATED CODE
|
2
|
+
#
|
3
|
+
# This file is generated. See the contributing guide for more information:
|
4
|
+
# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
|
5
|
+
#
|
6
|
+
# WARNING ABOUT GENERATED CODE
|
7
|
+
|
8
|
+
require 'aws-sdk-core'
|
9
|
+
require 'aws-sigv4'
|
10
|
+
|
11
|
+
require_relative 'aws-sdk-mturk/types'
|
12
|
+
require_relative 'aws-sdk-mturk/client_api'
|
13
|
+
require_relative 'aws-sdk-mturk/client'
|
14
|
+
require_relative 'aws-sdk-mturk/errors'
|
15
|
+
require_relative 'aws-sdk-mturk/resource'
|
16
|
+
require_relative 'aws-sdk-mturk/customizations'
|
17
|
+
|
18
|
+
# This module provides support for Amazon Mechanical Turk. This module is available in the
|
19
|
+
# `aws-sdk-mturk` gem.
|
20
|
+
#
|
21
|
+
# # Client
|
22
|
+
#
|
23
|
+
# The {Client} class provides one method for each API operation. Operation
|
24
|
+
# methods each accept a hash of request parameters and return a response
|
25
|
+
# structure.
|
26
|
+
#
|
27
|
+
# See {Client} for more information.
|
28
|
+
#
|
29
|
+
# # Errors
|
30
|
+
#
|
31
|
+
# Errors returned from Amazon Mechanical Turk all
|
32
|
+
# extend {Errors::ServiceError}.
|
33
|
+
#
|
34
|
+
# begin
|
35
|
+
# # do stuff
|
36
|
+
# rescue Aws::MTurk::Errors::ServiceError
|
37
|
+
# # rescues all service API errors
|
38
|
+
# end
|
39
|
+
#
|
40
|
+
# See {Errors} for more information.
|
41
|
+
#
|
42
|
+
# @service
|
43
|
+
module Aws::MTurk
|
44
|
+
|
45
|
+
GEM_VERSION = '1.0.0.rc1'
|
46
|
+
|
47
|
+
end
|
@@ -0,0 +1,2660 @@
|
|
1
|
+
# WARNING ABOUT GENERATED CODE
|
2
|
+
#
|
3
|
+
# This file is generated. See the contributing guide for more information:
|
4
|
+
# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
|
5
|
+
#
|
6
|
+
# WARNING ABOUT GENERATED CODE
|
7
|
+
|
8
|
+
require 'seahorse/client/plugins/content_length.rb'
|
9
|
+
require 'aws-sdk-core/plugins/credentials_configuration.rb'
|
10
|
+
require 'aws-sdk-core/plugins/logging.rb'
|
11
|
+
require 'aws-sdk-core/plugins/param_converter.rb'
|
12
|
+
require 'aws-sdk-core/plugins/param_validator.rb'
|
13
|
+
require 'aws-sdk-core/plugins/user_agent.rb'
|
14
|
+
require 'aws-sdk-core/plugins/helpful_socket_errors.rb'
|
15
|
+
require 'aws-sdk-core/plugins/retry_errors.rb'
|
16
|
+
require 'aws-sdk-core/plugins/global_configuration.rb'
|
17
|
+
require 'aws-sdk-core/plugins/regional_endpoint.rb'
|
18
|
+
require 'aws-sdk-core/plugins/response_paging.rb'
|
19
|
+
require 'aws-sdk-core/plugins/stub_responses.rb'
|
20
|
+
require 'aws-sdk-core/plugins/idempotency_token.rb'
|
21
|
+
require 'aws-sdk-core/plugins/signature_v4.rb'
|
22
|
+
require 'aws-sdk-core/plugins/protocols/json_rpc.rb'
|
23
|
+
|
24
|
+
Aws::Plugins::GlobalConfiguration.add_identifier(:mturk)
|
25
|
+
|
26
|
+
module Aws::MTurk
|
27
|
+
class Client < Seahorse::Client::Base
|
28
|
+
|
29
|
+
include Aws::ClientStubs
|
30
|
+
|
31
|
+
@identifier = :mturk
|
32
|
+
|
33
|
+
set_api(ClientApi::API)
|
34
|
+
|
35
|
+
add_plugin(Seahorse::Client::Plugins::ContentLength)
|
36
|
+
add_plugin(Aws::Plugins::CredentialsConfiguration)
|
37
|
+
add_plugin(Aws::Plugins::Logging)
|
38
|
+
add_plugin(Aws::Plugins::ParamConverter)
|
39
|
+
add_plugin(Aws::Plugins::ParamValidator)
|
40
|
+
add_plugin(Aws::Plugins::UserAgent)
|
41
|
+
add_plugin(Aws::Plugins::HelpfulSocketErrors)
|
42
|
+
add_plugin(Aws::Plugins::RetryErrors)
|
43
|
+
add_plugin(Aws::Plugins::GlobalConfiguration)
|
44
|
+
add_plugin(Aws::Plugins::RegionalEndpoint)
|
45
|
+
add_plugin(Aws::Plugins::ResponsePaging)
|
46
|
+
add_plugin(Aws::Plugins::StubResponses)
|
47
|
+
add_plugin(Aws::Plugins::IdempotencyToken)
|
48
|
+
add_plugin(Aws::Plugins::SignatureV4)
|
49
|
+
add_plugin(Aws::Plugins::Protocols::JsonRpc)
|
50
|
+
|
51
|
+
# @option options [required, Aws::CredentialProvider] :credentials
|
52
|
+
# Your AWS credentials. This can be an instance of any one of the
|
53
|
+
# following classes:
|
54
|
+
#
|
55
|
+
# * `Aws::Credentials` - Used for configuring static, non-refreshing
|
56
|
+
# credentials.
|
57
|
+
#
|
58
|
+
# * `Aws::InstanceProfileCredentials` - Used for loading credentials
|
59
|
+
# from an EC2 IMDS on an EC2 instance.
|
60
|
+
#
|
61
|
+
# * `Aws::SharedCredentials` - Used for loading credentials from a
|
62
|
+
# shared file, such as `~/.aws/config`.
|
63
|
+
#
|
64
|
+
# * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
|
65
|
+
#
|
66
|
+
# When `:credentials` are not configured directly, the following
|
67
|
+
# locations will be searched for credentials:
|
68
|
+
#
|
69
|
+
# * `Aws.config[:credentials]`
|
70
|
+
# * The `:access_key_id`, `:secret_access_key`, and `:session_token` options.
|
71
|
+
# * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
|
72
|
+
# * `~/.aws/credentials`
|
73
|
+
# * `~/.aws/config`
|
74
|
+
# * EC2 IMDS instance profile - When used by default, the timeouts are
|
75
|
+
# very aggressive. Construct and pass an instance of
|
76
|
+
# `Aws::InstanceProfileCredentails` to enable retries and extended
|
77
|
+
# timeouts.
|
78
|
+
#
|
79
|
+
# @option options [required, String] :region
|
80
|
+
# The AWS region to connect to. The configured `:region` is
|
81
|
+
# used to determine the service `:endpoint`. When not passed,
|
82
|
+
# a default `:region` is search for in the following locations:
|
83
|
+
#
|
84
|
+
# * `Aws.config[:region]`
|
85
|
+
# * `ENV['AWS_REGION']`
|
86
|
+
# * `ENV['AMAZON_REGION']`
|
87
|
+
# * `ENV['AWS_DEFAULT_REGION']`
|
88
|
+
# * `~/.aws/credentials`
|
89
|
+
# * `~/.aws/config`
|
90
|
+
#
|
91
|
+
# @option options [String] :access_key_id
|
92
|
+
#
|
93
|
+
# @option options [Boolean] :convert_params (true)
|
94
|
+
# When `true`, an attempt is made to coerce request parameters into
|
95
|
+
# the required types.
|
96
|
+
#
|
97
|
+
# @option options [String] :endpoint
|
98
|
+
# The client endpoint is normally constructed from the `:region`
|
99
|
+
# option. You should only configure an `:endpoint` when connecting
|
100
|
+
# to test endpoints. This should be avalid HTTP(S) URI.
|
101
|
+
#
|
102
|
+
# @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
|
103
|
+
# The log formatter.
|
104
|
+
#
|
105
|
+
# @option options [Symbol] :log_level (:info)
|
106
|
+
# The log level to send messages to the `:logger` at.
|
107
|
+
#
|
108
|
+
# @option options [Logger] :logger
|
109
|
+
# The Logger instance to send log messages to. If this option
|
110
|
+
# is not set, logging will be disabled.
|
111
|
+
#
|
112
|
+
# @option options [String] :profile ("default")
|
113
|
+
# Used when loading credentials from the shared credentials file
|
114
|
+
# at HOME/.aws/credentials. When not specified, 'default' is used.
|
115
|
+
#
|
116
|
+
# @option options [Integer] :retry_limit (3)
|
117
|
+
# The maximum number of times to retry failed requests. Only
|
118
|
+
# ~ 500 level server errors and certain ~ 400 level client errors
|
119
|
+
# are retried. Generally, these are throttling errors, data
|
120
|
+
# checksum errors, networking errors, timeout errors and auth
|
121
|
+
# errors from expired credentials.
|
122
|
+
#
|
123
|
+
# @option options [String] :secret_access_key
|
124
|
+
#
|
125
|
+
# @option options [String] :session_token
|
126
|
+
#
|
127
|
+
# @option options [Boolean] :simple_json (false)
|
128
|
+
# Disables request parameter conversion, validation, and formatting.
|
129
|
+
# Also disable response data type conversions. This option is useful
|
130
|
+
# when you want to ensure the highest level of performance by
|
131
|
+
# avoiding overhead of walking request parameters and response data
|
132
|
+
# structures.
|
133
|
+
#
|
134
|
+
# When `:simple_json` is enabled, the request parameters hash must
|
135
|
+
# be formatted exactly as the DynamoDB API expects.
|
136
|
+
#
|
137
|
+
# @option options [Boolean] :stub_responses (false)
|
138
|
+
# Causes the client to return stubbed responses. By default
|
139
|
+
# fake responses are generated and returned. You can specify
|
140
|
+
# the response data to return or errors to raise by calling
|
141
|
+
# {ClientStubs#stub_responses}. See {ClientStubs} for more information.
|
142
|
+
#
|
143
|
+
# ** Please note ** When response stubbing is enabled, no HTTP
|
144
|
+
# requests are made, and retries are disabled.
|
145
|
+
#
|
146
|
+
# @option options [Boolean] :validate_params (true)
|
147
|
+
# When `true`, request parameters are validated before
|
148
|
+
# sending the request.
|
149
|
+
#
|
150
|
+
def initialize(*args)
|
151
|
+
super
|
152
|
+
end
|
153
|
+
|
154
|
+
# @!group API Operations
|
155
|
+
|
156
|
+
# The `AcceptQualificationRequest` operation approves a Worker's
|
157
|
+
# request for a Qualification.
|
158
|
+
#
|
159
|
+
# Only the owner of the Qualification type can grant a Qualification
|
160
|
+
# request for that type.
|
161
|
+
#
|
162
|
+
# A successful request for the `AcceptQualificationRequest` operation
|
163
|
+
# returns with no errors and an empty body.
|
164
|
+
#
|
165
|
+
# @option params [required, String] :qualification_request_id
|
166
|
+
# The ID of the Qualification request, as returned by the
|
167
|
+
# `GetQualificationRequests` operation.
|
168
|
+
#
|
169
|
+
# @option params [Integer] :integer_value
|
170
|
+
# The value of the Qualification. You can omit this value if you are
|
171
|
+
# using the presence or absence of the Qualification as the basis for a
|
172
|
+
# HIT requirement.
|
173
|
+
#
|
174
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
175
|
+
#
|
176
|
+
# @example Request syntax with placeholder values
|
177
|
+
#
|
178
|
+
# resp = client.accept_qualification_request({
|
179
|
+
# qualification_request_id: "String", # required
|
180
|
+
# integer_value: 1,
|
181
|
+
# })
|
182
|
+
#
|
183
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mturk-requester-2017-01-17/AcceptQualificationRequest AWS API Documentation
|
184
|
+
#
|
185
|
+
# @overload accept_qualification_request(params = {})
|
186
|
+
# @param [Hash] params ({})
|
187
|
+
def accept_qualification_request(params = {}, options = {})
|
188
|
+
req = build_request(:accept_qualification_request, params)
|
189
|
+
req.send_request(options)
|
190
|
+
end
|
191
|
+
|
192
|
+
# The `ApproveAssignment` operation approves the results of a completed
|
193
|
+
# assignment.
|
194
|
+
#
|
195
|
+
# Approving an assignment initiates two payments from the Requester's
|
196
|
+
# Amazon.com account
|
197
|
+
#
|
198
|
+
# * The Worker who submitted the results is paid the reward specified in
|
199
|
+
# the HIT.
|
200
|
+
#
|
201
|
+
# * Amazon Mechanical Turk fees are debited.
|
202
|
+
#
|
203
|
+
# If the Requester's account does not have adequate funds for these
|
204
|
+
# payments, the call to ApproveAssignment returns an exception, and the
|
205
|
+
# approval is not processed. You can include an optional feedback
|
206
|
+
# message with the approval, which the Worker can see in the Status
|
207
|
+
# section of the web site.
|
208
|
+
#
|
209
|
+
# You can also call this operation for assignments that were previous
|
210
|
+
# rejected and approve them by explicitly overriding the previous
|
211
|
+
# rejection. This only works on rejected assignments that were submitted
|
212
|
+
# within the previous 30 days and only if the assignment's related HIT
|
213
|
+
# has not been deleted.
|
214
|
+
#
|
215
|
+
# @option params [required, String] :assignment_id
|
216
|
+
# The ID of the assignment. The assignment must correspond to a HIT
|
217
|
+
# created by the Requester.
|
218
|
+
#
|
219
|
+
# @option params [String] :requester_feedback
|
220
|
+
# A message for the Worker, which the Worker can see in the Status
|
221
|
+
# section of the web site.
|
222
|
+
#
|
223
|
+
# @option params [Boolean] :override_rejection
|
224
|
+
# A flag indicating that an assignment should be approved even if it was
|
225
|
+
# previously rejected. Defaults to `False`.
|
226
|
+
#
|
227
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
228
|
+
#
|
229
|
+
# @example Request syntax with placeholder values
|
230
|
+
#
|
231
|
+
# resp = client.approve_assignment({
|
232
|
+
# assignment_id: "EntityId", # required
|
233
|
+
# requester_feedback: "String",
|
234
|
+
# override_rejection: false,
|
235
|
+
# })
|
236
|
+
#
|
237
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mturk-requester-2017-01-17/ApproveAssignment AWS API Documentation
|
238
|
+
#
|
239
|
+
# @overload approve_assignment(params = {})
|
240
|
+
# @param [Hash] params ({})
|
241
|
+
def approve_assignment(params = {}, options = {})
|
242
|
+
req = build_request(:approve_assignment, params)
|
243
|
+
req.send_request(options)
|
244
|
+
end
|
245
|
+
|
246
|
+
# The `AssociateQualificationWithWorker` operation gives a Worker a
|
247
|
+
# Qualification. `AssociateQualificationWithWorker` does not require
|
248
|
+
# that the Worker submit a Qualification request. It gives the
|
249
|
+
# Qualification directly to the Worker.
|
250
|
+
#
|
251
|
+
# You can only assign a Qualification of a Qualification type that you
|
252
|
+
# created (using the `CreateQualificationType` operation).
|
253
|
+
#
|
254
|
+
# <note markdown="1"> Note: `AssociateQualificationWithWorker` does not affect any pending
|
255
|
+
# Qualification requests for the Qualification by the Worker. If you
|
256
|
+
# assign a Qualification to a Worker, then later grant a Qualification
|
257
|
+
# request made by the Worker, the granting of the request may modify the
|
258
|
+
# Qualification score. To resolve a pending Qualification request
|
259
|
+
# without affecting the Qualification the Worker already has, reject the
|
260
|
+
# request with the `RejectQualificationRequest` operation.
|
261
|
+
#
|
262
|
+
# </note>
|
263
|
+
#
|
264
|
+
# @option params [required, String] :qualification_type_id
|
265
|
+
# The ID of the Qualification type to use for the assigned
|
266
|
+
# Qualification.
|
267
|
+
#
|
268
|
+
# @option params [required, String] :worker_id
|
269
|
+
# The ID of the Worker to whom the Qualification is being assigned.
|
270
|
+
# Worker IDs are included with submitted HIT assignments and
|
271
|
+
# Qualification requests.
|
272
|
+
#
|
273
|
+
# @option params [Integer] :integer_value
|
274
|
+
# The value of the Qualification to assign.
|
275
|
+
#
|
276
|
+
# @option params [Boolean] :send_notification
|
277
|
+
# Specifies whether to send a notification email message to the Worker
|
278
|
+
# saying that the qualification was assigned to the Worker. Note: this
|
279
|
+
# is true by default.
|
280
|
+
#
|
281
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
282
|
+
#
|
283
|
+
# @example Request syntax with placeholder values
|
284
|
+
#
|
285
|
+
# resp = client.associate_qualification_with_worker({
|
286
|
+
# qualification_type_id: "EntityId", # required
|
287
|
+
# worker_id: "CustomerId", # required
|
288
|
+
# integer_value: 1,
|
289
|
+
# send_notification: false,
|
290
|
+
# })
|
291
|
+
#
|
292
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mturk-requester-2017-01-17/AssociateQualificationWithWorker AWS API Documentation
|
293
|
+
#
|
294
|
+
# @overload associate_qualification_with_worker(params = {})
|
295
|
+
# @param [Hash] params ({})
|
296
|
+
def associate_qualification_with_worker(params = {}, options = {})
|
297
|
+
req = build_request(:associate_qualification_with_worker, params)
|
298
|
+
req.send_request(options)
|
299
|
+
end
|
300
|
+
|
301
|
+
# The `CreateAdditionalAssignmentsForHIT` operation increases the
|
302
|
+
# maximum number of assignments of an existing HIT.
|
303
|
+
#
|
304
|
+
# To extend the maximum number of assignments, specify the number of
|
305
|
+
# additional assignments.
|
306
|
+
#
|
307
|
+
# <note markdown="1"> * HITs created with fewer than 10 assignments cannot be extended to
|
308
|
+
# have 10 or more assignments. Attempting to add assignments in a way
|
309
|
+
# that brings the total number of assignments for a HIT from fewer
|
310
|
+
# than 10 assignments to 10 or more assignments will result in an
|
311
|
+
# `AWS.MechanicalTurk.InvalidMaximumAssignmentsIncrease` exception.
|
312
|
+
#
|
313
|
+
# * HITs that were created before July 22, 2015 cannot be extended.
|
314
|
+
# Attempting to extend HITs that were created before July 22, 2015
|
315
|
+
# will result in an `AWS.MechanicalTurk.HITTooOldForExtension`
|
316
|
+
# exception.
|
317
|
+
#
|
318
|
+
# </note>
|
319
|
+
#
|
320
|
+
# @option params [required, String] :hit_id
|
321
|
+
# The ID of the HIT to extend.
|
322
|
+
#
|
323
|
+
# @option params [Integer] :number_of_additional_assignments
|
324
|
+
# The number of additional assignments to request for this HIT.
|
325
|
+
#
|
326
|
+
# @option params [String] :unique_request_token
|
327
|
+
# A unique identifier for this request, which allows you to retry the
|
328
|
+
# call on error without extending the HIT multiple times. This is useful
|
329
|
+
# in cases such as network timeouts where it is unclear whether or not
|
330
|
+
# the call succeeded on the server. If the extend HIT already exists in
|
331
|
+
# the system from a previous call using the same `UniqueRequestToken`,
|
332
|
+
# subsequent calls will return an error with a message containing the
|
333
|
+
# request ID.
|
334
|
+
#
|
335
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
336
|
+
#
|
337
|
+
# @example Request syntax with placeholder values
|
338
|
+
#
|
339
|
+
# resp = client.create_additional_assignments_for_hit({
|
340
|
+
# hit_id: "EntityId", # required
|
341
|
+
# number_of_additional_assignments: 1,
|
342
|
+
# unique_request_token: "IdempotencyToken",
|
343
|
+
# })
|
344
|
+
#
|
345
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mturk-requester-2017-01-17/CreateAdditionalAssignmentsForHIT AWS API Documentation
|
346
|
+
#
|
347
|
+
# @overload create_additional_assignments_for_hit(params = {})
|
348
|
+
# @param [Hash] params ({})
|
349
|
+
def create_additional_assignments_for_hit(params = {}, options = {})
|
350
|
+
req = build_request(:create_additional_assignments_for_hit, params)
|
351
|
+
req.send_request(options)
|
352
|
+
end
|
353
|
+
|
354
|
+
# The `CreateHIT` operation creates a new Human Intelligence Task (HIT).
|
355
|
+
# The new HIT is made available for Workers to find and accept on the
|
356
|
+
# Amazon Mechanical Turk website.
|
357
|
+
#
|
358
|
+
# This operation allows you to specify a new HIT by passing in values
|
359
|
+
# for the properties of the HIT, such as its title, reward amount and
|
360
|
+
# number of assignments. When you pass these values to `CreateHIT`, a
|
361
|
+
# new HIT is created for you, with a new `HITTypeID`. The HITTypeID can
|
362
|
+
# be used to create additional HITs in the future without needing to
|
363
|
+
# specify common parameters such as the title, description and reward
|
364
|
+
# amount each time.
|
365
|
+
#
|
366
|
+
# An alternative way to create HITs is to first generate a HITTypeID
|
367
|
+
# using the `CreateHITType` operation and then call the
|
368
|
+
# `CreateHITWithHITType` operation. This is the recommended best
|
369
|
+
# practice for Requesters who are creating large numbers of HITs.
|
370
|
+
#
|
371
|
+
# CreateHIT also supports several ways to provide question data: by
|
372
|
+
# providing a value for the `Question` parameter that fully specifies
|
373
|
+
# the contents of the HIT, or by providing a `HitLayoutId` and
|
374
|
+
# associated `HitLayoutParameters`.
|
375
|
+
#
|
376
|
+
# <note markdown="1"> If a HIT is created with 10 or more maximum assignments, there is an
|
377
|
+
# additional fee. For more information, see [Amazon Mechanical Turk
|
378
|
+
# Pricing][1].
|
379
|
+
#
|
380
|
+
# </note>
|
381
|
+
#
|
382
|
+
#
|
383
|
+
#
|
384
|
+
# [1]: https://requester.mturk.com/pricing
|
385
|
+
#
|
386
|
+
# @option params [Integer] :max_assignments
|
387
|
+
# The number of times the HIT can be accepted and completed before the
|
388
|
+
# HIT becomes unavailable.
|
389
|
+
#
|
390
|
+
# @option params [Integer] :auto_approval_delay_in_seconds
|
391
|
+
# The number of seconds after an assignment for the HIT has been
|
392
|
+
# submitted, after which the assignment is considered Approved
|
393
|
+
# automatically unless the Requester explicitly rejects it.
|
394
|
+
#
|
395
|
+
# @option params [required, Integer] :lifetime_in_seconds
|
396
|
+
# An amount of time, in seconds, after which the HIT is no longer
|
397
|
+
# available for users to accept. After the lifetime of the HIT elapses,
|
398
|
+
# the HIT no longer appears in HIT searches, even if not all of the
|
399
|
+
# assignments for the HIT have been accepted.
|
400
|
+
#
|
401
|
+
# @option params [required, Integer] :assignment_duration_in_seconds
|
402
|
+
# The amount of time, in seconds, that a Worker has to complete the HIT
|
403
|
+
# after accepting it. If a Worker does not complete the assignment
|
404
|
+
# within the specified duration, the assignment is considered abandoned.
|
405
|
+
# If the HIT is still active (that is, its lifetime has not elapsed),
|
406
|
+
# the assignment becomes available for other users to find and accept.
|
407
|
+
#
|
408
|
+
# @option params [required, String] :reward
|
409
|
+
# The amount of money the Requester will pay a Worker for successfully
|
410
|
+
# completing the HIT.
|
411
|
+
#
|
412
|
+
# @option params [required, String] :title
|
413
|
+
# The title of the HIT. A title should be short and descriptive about
|
414
|
+
# the kind of task the HIT contains. On the Amazon Mechanical Turk web
|
415
|
+
# site, the HIT title appears in search results, and everywhere the HIT
|
416
|
+
# is mentioned.
|
417
|
+
#
|
418
|
+
# @option params [String] :keywords
|
419
|
+
# One or more words or phrases that describe the HIT, separated by
|
420
|
+
# commas. These words are used in searches to find HITs.
|
421
|
+
#
|
422
|
+
# @option params [required, String] :description
|
423
|
+
# A general description of the HIT. A description includes detailed
|
424
|
+
# information about the kind of task the HIT contains. On the Amazon
|
425
|
+
# Mechanical Turk web site, the HIT description appears in the expanded
|
426
|
+
# view of search results, and in the HIT and assignment screens. A good
|
427
|
+
# description gives the user enough information to evaluate the HIT
|
428
|
+
# before accepting it.
|
429
|
+
#
|
430
|
+
# @option params [String] :question
|
431
|
+
# The data the person completing the HIT uses to produce the results.
|
432
|
+
#
|
433
|
+
# Constraints: Must be a QuestionForm data structure, an
|
434
|
+
# ExternalQuestion data structure, or an HTMLQuestion data structure.
|
435
|
+
# The XML question data must not be larger than 64 kilobytes (65,535
|
436
|
+
# bytes) in size, including whitespace.
|
437
|
+
#
|
438
|
+
# Either a Question parameter or a HITLayoutId parameter must be
|
439
|
+
# provided.
|
440
|
+
#
|
441
|
+
# @option params [String] :requester_annotation
|
442
|
+
# An arbitrary data field. The RequesterAnnotation parameter lets your
|
443
|
+
# application attach arbitrary data to the HIT for tracking purposes.
|
444
|
+
# For example, this parameter could be an identifier internal to the
|
445
|
+
# Requester's application that corresponds with the HIT.
|
446
|
+
#
|
447
|
+
# The RequesterAnnotation parameter for a HIT is only visible to the
|
448
|
+
# Requester who created the HIT. It is not shown to the Worker, or any
|
449
|
+
# other Requester.
|
450
|
+
#
|
451
|
+
# The RequesterAnnotation parameter may be different for each HIT you
|
452
|
+
# submit. It does not affect how your HITs are grouped.
|
453
|
+
#
|
454
|
+
# @option params [Array<Types::QualificationRequirement>] :qualification_requirements
|
455
|
+
# A condition that a Worker's Qualifications must meet before the
|
456
|
+
# Worker is allowed to accept and complete the HIT.
|
457
|
+
#
|
458
|
+
# @option params [String] :unique_request_token
|
459
|
+
# A unique identifier for this request which allows you to retry the
|
460
|
+
# call on error without creating duplicate HITs. This is useful in cases
|
461
|
+
# such as network timeouts where it is unclear whether or not the call
|
462
|
+
# succeeded on the server. If the HIT already exists in the system from
|
463
|
+
# a previous call using the same UniqueRequestToken, subsequent calls
|
464
|
+
# will return a AWS.MechanicalTurk.HitAlreadyExists error with a message
|
465
|
+
# containing the HITId.
|
466
|
+
#
|
467
|
+
# <note markdown="1"> Note: It is your responsibility to ensure uniqueness of the token. The
|
468
|
+
# unique token expires after 24 hours. Subsequent calls using the same
|
469
|
+
# UniqueRequestToken made after the 24 hour limit could create duplicate
|
470
|
+
# HITs.
|
471
|
+
#
|
472
|
+
# </note>
|
473
|
+
#
|
474
|
+
# @option params [Types::ReviewPolicy] :assignment_review_policy
|
475
|
+
# The Assignment-level Review Policy applies to the assignments under
|
476
|
+
# the HIT. You can specify for Mechanical Turk to take various actions
|
477
|
+
# based on the policy.
|
478
|
+
#
|
479
|
+
# @option params [Types::ReviewPolicy] :hit_review_policy
|
480
|
+
# The HIT-level Review Policy applies to the HIT. You can specify for
|
481
|
+
# Mechanical Turk to take various actions based on the policy.
|
482
|
+
#
|
483
|
+
# @option params [String] :hit_layout_id
|
484
|
+
# The HITLayoutId allows you to use a pre-existing HIT design with
|
485
|
+
# placeholder values and create an additional HIT by providing those
|
486
|
+
# values as HITLayoutParameters.
|
487
|
+
#
|
488
|
+
# Constraints: Either a Question parameter or a HITLayoutId parameter
|
489
|
+
# must be provided.
|
490
|
+
#
|
491
|
+
# @option params [Array<Types::HITLayoutParameter>] :hit_layout_parameters
|
492
|
+
# If the HITLayoutId is provided, any placeholder values must be filled
|
493
|
+
# in with values using the HITLayoutParameter structure. For more
|
494
|
+
# information, see HITLayout.
|
495
|
+
#
|
496
|
+
# @return [Types::CreateHITResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
497
|
+
#
|
498
|
+
# * {Types::CreateHITResponse#hit #hit} => Types::HIT
|
499
|
+
#
|
500
|
+
# @example Request syntax with placeholder values
|
501
|
+
#
|
502
|
+
# resp = client.create_hit({
|
503
|
+
# max_assignments: 1,
|
504
|
+
# auto_approval_delay_in_seconds: 1,
|
505
|
+
# lifetime_in_seconds: 1, # required
|
506
|
+
# assignment_duration_in_seconds: 1, # required
|
507
|
+
# reward: "NumericValue", # required
|
508
|
+
# title: "String", # required
|
509
|
+
# keywords: "String",
|
510
|
+
# description: "String", # required
|
511
|
+
# question: "String",
|
512
|
+
# requester_annotation: "String",
|
513
|
+
# qualification_requirements: [
|
514
|
+
# {
|
515
|
+
# qualification_type_id: "String", # required
|
516
|
+
# comparator: "LessThan", # required, accepts LessThan, LessThanOrEqualTo, GreaterThan, GreaterThanOrEqualTo, EqualTo, NotEqualTo, Exists, DoesNotExist, In, NotIn
|
517
|
+
# integer_values: [1],
|
518
|
+
# locale_values: [
|
519
|
+
# {
|
520
|
+
# country: "CountryParameters", # required
|
521
|
+
# subdivision: "CountryParameters",
|
522
|
+
# },
|
523
|
+
# ],
|
524
|
+
# required_to_preview: false,
|
525
|
+
# },
|
526
|
+
# ],
|
527
|
+
# unique_request_token: "IdempotencyToken",
|
528
|
+
# assignment_review_policy: {
|
529
|
+
# policy_name: "String",
|
530
|
+
# parameters: [
|
531
|
+
# {
|
532
|
+
# key: "String",
|
533
|
+
# values: ["String"],
|
534
|
+
# map_entries: [
|
535
|
+
# {
|
536
|
+
# key: "String",
|
537
|
+
# values: ["String"],
|
538
|
+
# },
|
539
|
+
# ],
|
540
|
+
# },
|
541
|
+
# ],
|
542
|
+
# },
|
543
|
+
# hit_review_policy: {
|
544
|
+
# policy_name: "String",
|
545
|
+
# parameters: [
|
546
|
+
# {
|
547
|
+
# key: "String",
|
548
|
+
# values: ["String"],
|
549
|
+
# map_entries: [
|
550
|
+
# {
|
551
|
+
# key: "String",
|
552
|
+
# values: ["String"],
|
553
|
+
# },
|
554
|
+
# ],
|
555
|
+
# },
|
556
|
+
# ],
|
557
|
+
# },
|
558
|
+
# hit_layout_id: "EntityId",
|
559
|
+
# hit_layout_parameters: [
|
560
|
+
# {
|
561
|
+
# name: "String",
|
562
|
+
# value: "String",
|
563
|
+
# },
|
564
|
+
# ],
|
565
|
+
# })
|
566
|
+
#
|
567
|
+
# @example Response structure
|
568
|
+
#
|
569
|
+
# resp.hit.hit_id #=> String
|
570
|
+
# resp.hit.hit_type_id #=> String
|
571
|
+
# resp.hit.hit_group_id #=> String
|
572
|
+
# resp.hit.hit_layout_id #=> String
|
573
|
+
# resp.hit.creation_time #=> Time
|
574
|
+
# resp.hit.title #=> String
|
575
|
+
# resp.hit.description #=> String
|
576
|
+
# resp.hit.question #=> String
|
577
|
+
# resp.hit.keywords #=> String
|
578
|
+
# resp.hit.hit_status #=> String, one of "Assignable", "Unassignable", "Reviewable", "Reviewing", "Disposed"
|
579
|
+
# resp.hit.max_assignments #=> Integer
|
580
|
+
# resp.hit.reward #=> String
|
581
|
+
# resp.hit.auto_approval_delay_in_seconds #=> Integer
|
582
|
+
# resp.hit.expiration #=> Time
|
583
|
+
# resp.hit.assignment_duration_in_seconds #=> Integer
|
584
|
+
# resp.hit.requester_annotation #=> String
|
585
|
+
# resp.hit.qualification_requirements #=> Array
|
586
|
+
# resp.hit.qualification_requirements[0].qualification_type_id #=> String
|
587
|
+
# resp.hit.qualification_requirements[0].comparator #=> String, one of "LessThan", "LessThanOrEqualTo", "GreaterThan", "GreaterThanOrEqualTo", "EqualTo", "NotEqualTo", "Exists", "DoesNotExist", "In", "NotIn"
|
588
|
+
# resp.hit.qualification_requirements[0].integer_values #=> Array
|
589
|
+
# resp.hit.qualification_requirements[0].integer_values[0] #=> Integer
|
590
|
+
# resp.hit.qualification_requirements[0].locale_values #=> Array
|
591
|
+
# resp.hit.qualification_requirements[0].locale_values[0].country #=> String
|
592
|
+
# resp.hit.qualification_requirements[0].locale_values[0].subdivision #=> String
|
593
|
+
# resp.hit.qualification_requirements[0].required_to_preview #=> Boolean
|
594
|
+
# resp.hit.hit_review_status #=> String, one of "NotReviewed", "MarkedForReview", "ReviewedAppropriate", "ReviewedInappropriate"
|
595
|
+
# resp.hit.number_of_assignments_pending #=> Integer
|
596
|
+
# resp.hit.number_of_assignments_available #=> Integer
|
597
|
+
# resp.hit.number_of_assignments_completed #=> Integer
|
598
|
+
#
|
599
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mturk-requester-2017-01-17/CreateHIT AWS API Documentation
|
600
|
+
#
|
601
|
+
# @overload create_hit(params = {})
|
602
|
+
# @param [Hash] params ({})
|
603
|
+
def create_hit(params = {}, options = {})
|
604
|
+
req = build_request(:create_hit, params)
|
605
|
+
req.send_request(options)
|
606
|
+
end
|
607
|
+
|
608
|
+
# The `CreateHITType` operation creates a new HIT type. This operation
|
609
|
+
# allows you to define a standard set of HIT properties to use when
|
610
|
+
# creating HITs. If you register a HIT type with values that match an
|
611
|
+
# existing HIT type, the HIT type ID of the existing type will be
|
612
|
+
# returned.
|
613
|
+
#
|
614
|
+
# @option params [Integer] :auto_approval_delay_in_seconds
|
615
|
+
# The number of seconds after an assignment for the HIT has been
|
616
|
+
# submitted, after which the assignment is considered Approved
|
617
|
+
# automatically unless the Requester explicitly rejects it.
|
618
|
+
#
|
619
|
+
# @option params [required, Integer] :assignment_duration_in_seconds
|
620
|
+
# The amount of time, in seconds, that a Worker has to complete the HIT
|
621
|
+
# after accepting it. If a Worker does not complete the assignment
|
622
|
+
# within the specified duration, the assignment is considered abandoned.
|
623
|
+
# If the HIT is still active (that is, its lifetime has not elapsed),
|
624
|
+
# the assignment becomes available for other users to find and accept.
|
625
|
+
#
|
626
|
+
# @option params [required, String] :reward
|
627
|
+
# The amount of money the Requester will pay a Worker for successfully
|
628
|
+
# completing the HIT.
|
629
|
+
#
|
630
|
+
# @option params [required, String] :title
|
631
|
+
# The title of the HIT. A title should be short and descriptive about
|
632
|
+
# the kind of task the HIT contains. On the Amazon Mechanical Turk web
|
633
|
+
# site, the HIT title appears in search results, and everywhere the HIT
|
634
|
+
# is mentioned.
|
635
|
+
#
|
636
|
+
# @option params [String] :keywords
|
637
|
+
# One or more words or phrases that describe the HIT, separated by
|
638
|
+
# commas. These words are used in searches to find HITs.
|
639
|
+
#
|
640
|
+
# @option params [required, String] :description
|
641
|
+
# A general description of the HIT. A description includes detailed
|
642
|
+
# information about the kind of task the HIT contains. On the Amazon
|
643
|
+
# Mechanical Turk web site, the HIT description appears in the expanded
|
644
|
+
# view of search results, and in the HIT and assignment screens. A good
|
645
|
+
# description gives the user enough information to evaluate the HIT
|
646
|
+
# before accepting it.
|
647
|
+
#
|
648
|
+
# @option params [Array<Types::QualificationRequirement>] :qualification_requirements
|
649
|
+
# A condition that a Worker's Qualifications must meet before the
|
650
|
+
# Worker is allowed to accept and complete the HIT.
|
651
|
+
#
|
652
|
+
# @return [Types::CreateHITTypeResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
653
|
+
#
|
654
|
+
# * {Types::CreateHITTypeResponse#hit_type_id #hit_type_id} => String
|
655
|
+
#
|
656
|
+
# @example Request syntax with placeholder values
|
657
|
+
#
|
658
|
+
# resp = client.create_hit_type({
|
659
|
+
# auto_approval_delay_in_seconds: 1,
|
660
|
+
# assignment_duration_in_seconds: 1, # required
|
661
|
+
# reward: "NumericValue", # required
|
662
|
+
# title: "String", # required
|
663
|
+
# keywords: "String",
|
664
|
+
# description: "String", # required
|
665
|
+
# qualification_requirements: [
|
666
|
+
# {
|
667
|
+
# qualification_type_id: "String", # required
|
668
|
+
# comparator: "LessThan", # required, accepts LessThan, LessThanOrEqualTo, GreaterThan, GreaterThanOrEqualTo, EqualTo, NotEqualTo, Exists, DoesNotExist, In, NotIn
|
669
|
+
# integer_values: [1],
|
670
|
+
# locale_values: [
|
671
|
+
# {
|
672
|
+
# country: "CountryParameters", # required
|
673
|
+
# subdivision: "CountryParameters",
|
674
|
+
# },
|
675
|
+
# ],
|
676
|
+
# required_to_preview: false,
|
677
|
+
# },
|
678
|
+
# ],
|
679
|
+
# })
|
680
|
+
#
|
681
|
+
# @example Response structure
|
682
|
+
#
|
683
|
+
# resp.hit_type_id #=> String
|
684
|
+
#
|
685
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mturk-requester-2017-01-17/CreateHITType AWS API Documentation
|
686
|
+
#
|
687
|
+
# @overload create_hit_type(params = {})
|
688
|
+
# @param [Hash] params ({})
|
689
|
+
def create_hit_type(params = {}, options = {})
|
690
|
+
req = build_request(:create_hit_type, params)
|
691
|
+
req.send_request(options)
|
692
|
+
end
|
693
|
+
|
694
|
+
# The `CreateHITWithHITType` operation creates a new Human Intelligence
|
695
|
+
# Task (HIT) using an existing HITTypeID generated by the
|
696
|
+
# `CreateHITType` operation.
|
697
|
+
#
|
698
|
+
# This is an alternative way to create HITs from the `CreateHIT`
|
699
|
+
# operation. This is the recommended best practice for Requesters who
|
700
|
+
# are creating large numbers of HITs.
|
701
|
+
#
|
702
|
+
# CreateHITWithHITType also supports several ways to provide question
|
703
|
+
# data: by providing a value for the `Question` parameter that fully
|
704
|
+
# specifies the contents of the HIT, or by providing a `HitLayoutId` and
|
705
|
+
# associated `HitLayoutParameters`.
|
706
|
+
#
|
707
|
+
# <note markdown="1"> If a HIT is created with 10 or more maximum assignments, there is an
|
708
|
+
# additional fee. For more information, see [Amazon Mechanical Turk
|
709
|
+
# Pricing][1].
|
710
|
+
#
|
711
|
+
# </note>
|
712
|
+
#
|
713
|
+
#
|
714
|
+
#
|
715
|
+
# [1]: https://requester.mturk.com/pricing
|
716
|
+
#
|
717
|
+
# @option params [required, String] :hit_type_id
|
718
|
+
# The HIT type ID you want to create this HIT with.
|
719
|
+
#
|
720
|
+
# @option params [Integer] :max_assignments
|
721
|
+
# The number of times the HIT can be accepted and completed before the
|
722
|
+
# HIT becomes unavailable.
|
723
|
+
#
|
724
|
+
# @option params [required, Integer] :lifetime_in_seconds
|
725
|
+
# An amount of time, in seconds, after which the HIT is no longer
|
726
|
+
# available for users to accept. After the lifetime of the HIT elapses,
|
727
|
+
# the HIT no longer appears in HIT searches, even if not all of the
|
728
|
+
# assignments for the HIT have been accepted.
|
729
|
+
#
|
730
|
+
# @option params [String] :question
|
731
|
+
# The data the person completing the HIT uses to produce the results.
|
732
|
+
#
|
733
|
+
# Constraints: Must be a QuestionForm data structure, an
|
734
|
+
# ExternalQuestion data structure, or an HTMLQuestion data structure.
|
735
|
+
# The XML question data must not be larger than 64 kilobytes (65,535
|
736
|
+
# bytes) in size, including whitespace.
|
737
|
+
#
|
738
|
+
# Either a Question parameter or a HITLayoutId parameter must be
|
739
|
+
# provided.
|
740
|
+
#
|
741
|
+
# @option params [String] :requester_annotation
|
742
|
+
# An arbitrary data field. The RequesterAnnotation parameter lets your
|
743
|
+
# application attach arbitrary data to the HIT for tracking purposes.
|
744
|
+
# For example, this parameter could be an identifier internal to the
|
745
|
+
# Requester's application that corresponds with the HIT.
|
746
|
+
#
|
747
|
+
# The RequesterAnnotation parameter for a HIT is only visible to the
|
748
|
+
# Requester who created the HIT. It is not shown to the Worker, or any
|
749
|
+
# other Requester.
|
750
|
+
#
|
751
|
+
# The RequesterAnnotation parameter may be different for each HIT you
|
752
|
+
# submit. It does not affect how your HITs are grouped.
|
753
|
+
#
|
754
|
+
# @option params [String] :unique_request_token
|
755
|
+
# A unique identifier for this request which allows you to retry the
|
756
|
+
# call on error without creating duplicate HITs. This is useful in cases
|
757
|
+
# such as network timeouts where it is unclear whether or not the call
|
758
|
+
# succeeded on the server. If the HIT already exists in the system from
|
759
|
+
# a previous call using the same UniqueRequestToken, subsequent calls
|
760
|
+
# will return a AWS.MechanicalTurk.HitAlreadyExists error with a message
|
761
|
+
# containing the HITId.
|
762
|
+
#
|
763
|
+
# <note markdown="1"> Note: It is your responsibility to ensure uniqueness of the token. The
|
764
|
+
# unique token expires after 24 hours. Subsequent calls using the same
|
765
|
+
# UniqueRequestToken made after the 24 hour limit could create duplicate
|
766
|
+
# HITs.
|
767
|
+
#
|
768
|
+
# </note>
|
769
|
+
#
|
770
|
+
# @option params [Types::ReviewPolicy] :assignment_review_policy
|
771
|
+
# The Assignment-level Review Policy applies to the assignments under
|
772
|
+
# the HIT. You can specify for Mechanical Turk to take various actions
|
773
|
+
# based on the policy.
|
774
|
+
#
|
775
|
+
# @option params [Types::ReviewPolicy] :hit_review_policy
|
776
|
+
# The HIT-level Review Policy applies to the HIT. You can specify for
|
777
|
+
# Mechanical Turk to take various actions based on the policy.
|
778
|
+
#
|
779
|
+
# @option params [String] :hit_layout_id
|
780
|
+
# The HITLayoutId allows you to use a pre-existing HIT design with
|
781
|
+
# placeholder values and create an additional HIT by providing those
|
782
|
+
# values as HITLayoutParameters.
|
783
|
+
#
|
784
|
+
# Constraints: Either a Question parameter or a HITLayoutId parameter
|
785
|
+
# must be provided.
|
786
|
+
#
|
787
|
+
# @option params [Array<Types::HITLayoutParameter>] :hit_layout_parameters
|
788
|
+
# If the HITLayoutId is provided, any placeholder values must be filled
|
789
|
+
# in with values using the HITLayoutParameter structure. For more
|
790
|
+
# information, see HITLayout.
|
791
|
+
#
|
792
|
+
# @return [Types::CreateHITWithHITTypeResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
793
|
+
#
|
794
|
+
# * {Types::CreateHITWithHITTypeResponse#hit #hit} => Types::HIT
|
795
|
+
#
|
796
|
+
# @example Request syntax with placeholder values
|
797
|
+
#
|
798
|
+
# resp = client.create_hit_with_hit_type({
|
799
|
+
# hit_type_id: "EntityId", # required
|
800
|
+
# max_assignments: 1,
|
801
|
+
# lifetime_in_seconds: 1, # required
|
802
|
+
# question: "String",
|
803
|
+
# requester_annotation: "String",
|
804
|
+
# unique_request_token: "IdempotencyToken",
|
805
|
+
# assignment_review_policy: {
|
806
|
+
# policy_name: "String",
|
807
|
+
# parameters: [
|
808
|
+
# {
|
809
|
+
# key: "String",
|
810
|
+
# values: ["String"],
|
811
|
+
# map_entries: [
|
812
|
+
# {
|
813
|
+
# key: "String",
|
814
|
+
# values: ["String"],
|
815
|
+
# },
|
816
|
+
# ],
|
817
|
+
# },
|
818
|
+
# ],
|
819
|
+
# },
|
820
|
+
# hit_review_policy: {
|
821
|
+
# policy_name: "String",
|
822
|
+
# parameters: [
|
823
|
+
# {
|
824
|
+
# key: "String",
|
825
|
+
# values: ["String"],
|
826
|
+
# map_entries: [
|
827
|
+
# {
|
828
|
+
# key: "String",
|
829
|
+
# values: ["String"],
|
830
|
+
# },
|
831
|
+
# ],
|
832
|
+
# },
|
833
|
+
# ],
|
834
|
+
# },
|
835
|
+
# hit_layout_id: "EntityId",
|
836
|
+
# hit_layout_parameters: [
|
837
|
+
# {
|
838
|
+
# name: "String",
|
839
|
+
# value: "String",
|
840
|
+
# },
|
841
|
+
# ],
|
842
|
+
# })
|
843
|
+
#
|
844
|
+
# @example Response structure
|
845
|
+
#
|
846
|
+
# resp.hit.hit_id #=> String
|
847
|
+
# resp.hit.hit_type_id #=> String
|
848
|
+
# resp.hit.hit_group_id #=> String
|
849
|
+
# resp.hit.hit_layout_id #=> String
|
850
|
+
# resp.hit.creation_time #=> Time
|
851
|
+
# resp.hit.title #=> String
|
852
|
+
# resp.hit.description #=> String
|
853
|
+
# resp.hit.question #=> String
|
854
|
+
# resp.hit.keywords #=> String
|
855
|
+
# resp.hit.hit_status #=> String, one of "Assignable", "Unassignable", "Reviewable", "Reviewing", "Disposed"
|
856
|
+
# resp.hit.max_assignments #=> Integer
|
857
|
+
# resp.hit.reward #=> String
|
858
|
+
# resp.hit.auto_approval_delay_in_seconds #=> Integer
|
859
|
+
# resp.hit.expiration #=> Time
|
860
|
+
# resp.hit.assignment_duration_in_seconds #=> Integer
|
861
|
+
# resp.hit.requester_annotation #=> String
|
862
|
+
# resp.hit.qualification_requirements #=> Array
|
863
|
+
# resp.hit.qualification_requirements[0].qualification_type_id #=> String
|
864
|
+
# resp.hit.qualification_requirements[0].comparator #=> String, one of "LessThan", "LessThanOrEqualTo", "GreaterThan", "GreaterThanOrEqualTo", "EqualTo", "NotEqualTo", "Exists", "DoesNotExist", "In", "NotIn"
|
865
|
+
# resp.hit.qualification_requirements[0].integer_values #=> Array
|
866
|
+
# resp.hit.qualification_requirements[0].integer_values[0] #=> Integer
|
867
|
+
# resp.hit.qualification_requirements[0].locale_values #=> Array
|
868
|
+
# resp.hit.qualification_requirements[0].locale_values[0].country #=> String
|
869
|
+
# resp.hit.qualification_requirements[0].locale_values[0].subdivision #=> String
|
870
|
+
# resp.hit.qualification_requirements[0].required_to_preview #=> Boolean
|
871
|
+
# resp.hit.hit_review_status #=> String, one of "NotReviewed", "MarkedForReview", "ReviewedAppropriate", "ReviewedInappropriate"
|
872
|
+
# resp.hit.number_of_assignments_pending #=> Integer
|
873
|
+
# resp.hit.number_of_assignments_available #=> Integer
|
874
|
+
# resp.hit.number_of_assignments_completed #=> Integer
|
875
|
+
#
|
876
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mturk-requester-2017-01-17/CreateHITWithHITType AWS API Documentation
|
877
|
+
#
|
878
|
+
# @overload create_hit_with_hit_type(params = {})
|
879
|
+
# @param [Hash] params ({})
|
880
|
+
def create_hit_with_hit_type(params = {}, options = {})
|
881
|
+
req = build_request(:create_hit_with_hit_type, params)
|
882
|
+
req.send_request(options)
|
883
|
+
end
|
884
|
+
|
885
|
+
# The `CreateQualificationType` operation creates a new Qualification
|
886
|
+
# type, which is represented by a `QualificationType` data structure.
|
887
|
+
#
|
888
|
+
# @option params [required, String] :name
|
889
|
+
# The name you give to the Qualification type. The type name is used to
|
890
|
+
# represent the Qualification to Workers, and to find the type using a
|
891
|
+
# Qualification type search. It must be unique across all of your
|
892
|
+
# Qualification types.
|
893
|
+
#
|
894
|
+
# @option params [String] :keywords
|
895
|
+
# One or more words or phrases that describe the Qualification type,
|
896
|
+
# separated by commas. The keywords of a type make the type easier to
|
897
|
+
# find during a search.
|
898
|
+
#
|
899
|
+
# @option params [required, String] :description
|
900
|
+
# A long description for the Qualification type. On the Amazon
|
901
|
+
# Mechanical Turk website, the long description is displayed when a
|
902
|
+
# Worker examines a Qualification type.
|
903
|
+
#
|
904
|
+
# @option params [required, String] :qualification_type_status
|
905
|
+
# The initial status of the Qualification type.
|
906
|
+
#
|
907
|
+
# Constraints: Valid values are: Active \| Inactive
|
908
|
+
#
|
909
|
+
# @option params [Integer] :retry_delay_in_seconds
|
910
|
+
# The number of seconds that a Worker must wait after requesting a
|
911
|
+
# Qualification of the Qualification type before the worker can retry
|
912
|
+
# the Qualification request.
|
913
|
+
#
|
914
|
+
# Constraints: None. If not specified, retries are disabled and Workers
|
915
|
+
# can request a Qualification of this type only once, even if the Worker
|
916
|
+
# has not been granted the Qualification. It is not possible to disable
|
917
|
+
# retries for a Qualification type after it has been created with
|
918
|
+
# retries enabled. If you want to disable retries, you must delete
|
919
|
+
# existing retry-enabled Qualification type and then create a new
|
920
|
+
# Qualification type with retries disabled.
|
921
|
+
#
|
922
|
+
# @option params [String] :test
|
923
|
+
# The questions for the Qualification test a Worker must answer
|
924
|
+
# correctly to obtain a Qualification of this type. If this parameter is
|
925
|
+
# specified, `TestDurationInSeconds` must also be specified.
|
926
|
+
#
|
927
|
+
# Constraints: Must not be longer than 65535 bytes. Must be a
|
928
|
+
# QuestionForm data structure. This parameter cannot be specified if
|
929
|
+
# AutoGranted is true.
|
930
|
+
#
|
931
|
+
# Constraints: None. If not specified, the Worker may request the
|
932
|
+
# Qualification without answering any questions.
|
933
|
+
#
|
934
|
+
# @option params [String] :answer_key
|
935
|
+
# The answers to the Qualification test specified in the Test parameter,
|
936
|
+
# in the form of an AnswerKey data structure.
|
937
|
+
#
|
938
|
+
# Constraints: Must not be longer than 65535 bytes.
|
939
|
+
#
|
940
|
+
# Constraints: None. If not specified, you must process Qualification
|
941
|
+
# requests manually.
|
942
|
+
#
|
943
|
+
# @option params [Integer] :test_duration_in_seconds
|
944
|
+
# The number of seconds the Worker has to complete the Qualification
|
945
|
+
# test, starting from the time the Worker requests the Qualification.
|
946
|
+
#
|
947
|
+
# @option params [Boolean] :auto_granted
|
948
|
+
# Specifies whether requests for the Qualification type are granted
|
949
|
+
# immediately, without prompting the Worker with a Qualification test.
|
950
|
+
#
|
951
|
+
# Constraints: If the Test parameter is specified, this parameter cannot
|
952
|
+
# be true.
|
953
|
+
#
|
954
|
+
# @option params [Integer] :auto_granted_value
|
955
|
+
# The Qualification value to use for automatically granted
|
956
|
+
# Qualifications. This parameter is used only if the AutoGranted
|
957
|
+
# parameter is true.
|
958
|
+
#
|
959
|
+
# @return [Types::CreateQualificationTypeResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
960
|
+
#
|
961
|
+
# * {Types::CreateQualificationTypeResponse#qualification_type #qualification_type} => Types::QualificationType
|
962
|
+
#
|
963
|
+
# @example Request syntax with placeholder values
|
964
|
+
#
|
965
|
+
# resp = client.create_qualification_type({
|
966
|
+
# name: "String", # required
|
967
|
+
# keywords: "String",
|
968
|
+
# description: "String", # required
|
969
|
+
# qualification_type_status: "Active", # required, accepts Active, Inactive
|
970
|
+
# retry_delay_in_seconds: 1,
|
971
|
+
# test: "String",
|
972
|
+
# answer_key: "String",
|
973
|
+
# test_duration_in_seconds: 1,
|
974
|
+
# auto_granted: false,
|
975
|
+
# auto_granted_value: 1,
|
976
|
+
# })
|
977
|
+
#
|
978
|
+
# @example Response structure
|
979
|
+
#
|
980
|
+
# resp.qualification_type.qualification_type_id #=> String
|
981
|
+
# resp.qualification_type.creation_time #=> Time
|
982
|
+
# resp.qualification_type.name #=> String
|
983
|
+
# resp.qualification_type.description #=> String
|
984
|
+
# resp.qualification_type.keywords #=> String
|
985
|
+
# resp.qualification_type.qualification_type_status #=> String, one of "Active", "Inactive"
|
986
|
+
# resp.qualification_type.test #=> String
|
987
|
+
# resp.qualification_type.test_duration_in_seconds #=> Integer
|
988
|
+
# resp.qualification_type.answer_key #=> String
|
989
|
+
# resp.qualification_type.retry_delay_in_seconds #=> Integer
|
990
|
+
# resp.qualification_type.is_requestable #=> Boolean
|
991
|
+
# resp.qualification_type.auto_granted #=> Boolean
|
992
|
+
# resp.qualification_type.auto_granted_value #=> Integer
|
993
|
+
#
|
994
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mturk-requester-2017-01-17/CreateQualificationType AWS API Documentation
|
995
|
+
#
|
996
|
+
# @overload create_qualification_type(params = {})
|
997
|
+
# @param [Hash] params ({})
|
998
|
+
def create_qualification_type(params = {}, options = {})
|
999
|
+
req = build_request(:create_qualification_type, params)
|
1000
|
+
req.send_request(options)
|
1001
|
+
end
|
1002
|
+
|
1003
|
+
# The `CreateWorkerBlock` operation allows you to prevent a Worker from
|
1004
|
+
# working on your HITs. For example, you can block a Worker who is
|
1005
|
+
# producing poor quality work. You can block up to 100,000 Workers.
|
1006
|
+
#
|
1007
|
+
# @option params [required, String] :worker_id
|
1008
|
+
# The ID of the Worker to block.
|
1009
|
+
#
|
1010
|
+
# @option params [required, String] :reason
|
1011
|
+
# A message explaining the reason for blocking the Worker. This
|
1012
|
+
# parameter enables you to keep track of your Workers. The Worker does
|
1013
|
+
# not see this message.
|
1014
|
+
#
|
1015
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1016
|
+
#
|
1017
|
+
# @example Request syntax with placeholder values
|
1018
|
+
#
|
1019
|
+
# resp = client.create_worker_block({
|
1020
|
+
# worker_id: "CustomerId", # required
|
1021
|
+
# reason: "String", # required
|
1022
|
+
# })
|
1023
|
+
#
|
1024
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mturk-requester-2017-01-17/CreateWorkerBlock AWS API Documentation
|
1025
|
+
#
|
1026
|
+
# @overload create_worker_block(params = {})
|
1027
|
+
# @param [Hash] params ({})
|
1028
|
+
def create_worker_block(params = {}, options = {})
|
1029
|
+
req = build_request(:create_worker_block, params)
|
1030
|
+
req.send_request(options)
|
1031
|
+
end
|
1032
|
+
|
1033
|
+
# The `DeleteHIT` operation is used to delete HIT that is no longer
|
1034
|
+
# needed. Only the Requester who created the HIT can delete it.
|
1035
|
+
#
|
1036
|
+
# You can only dispose of HITs that are in the `Reviewable` state, with
|
1037
|
+
# all of their submitted assignments already either approved or
|
1038
|
+
# rejected. If you call the DeleteHIT operation on a HIT that is not in
|
1039
|
+
# the `Reviewable` state (for example, that has not expired, or still
|
1040
|
+
# has active assignments), or on a HIT that is Reviewable but without
|
1041
|
+
# all of its submitted assignments already approved or rejected, the
|
1042
|
+
# service will return an error.
|
1043
|
+
#
|
1044
|
+
# <note markdown="1"> * HITs are automatically disposed of after 120 days.
|
1045
|
+
#
|
1046
|
+
# * After you dispose of a HIT, you can no longer approve the HIT's
|
1047
|
+
# rejected assignments.
|
1048
|
+
#
|
1049
|
+
# * Disposed HITs are not returned in results for the ListHITs
|
1050
|
+
# operation.
|
1051
|
+
#
|
1052
|
+
# * Disposing HITs can improve the performance of operations such as
|
1053
|
+
# ListReviewableHITs and ListHITs.
|
1054
|
+
#
|
1055
|
+
# </note>
|
1056
|
+
#
|
1057
|
+
# @option params [required, String] :hit_id
|
1058
|
+
# The ID of the HIT to be deleted.
|
1059
|
+
#
|
1060
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1061
|
+
#
|
1062
|
+
# @example Request syntax with placeholder values
|
1063
|
+
#
|
1064
|
+
# resp = client.delete_hit({
|
1065
|
+
# hit_id: "EntityId", # required
|
1066
|
+
# })
|
1067
|
+
#
|
1068
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mturk-requester-2017-01-17/DeleteHIT AWS API Documentation
|
1069
|
+
#
|
1070
|
+
# @overload delete_hit(params = {})
|
1071
|
+
# @param [Hash] params ({})
|
1072
|
+
def delete_hit(params = {}, options = {})
|
1073
|
+
req = build_request(:delete_hit, params)
|
1074
|
+
req.send_request(options)
|
1075
|
+
end
|
1076
|
+
|
1077
|
+
# The `DeleteQualificationType` deletes a Qualification type and deletes
|
1078
|
+
# any HIT types that are associated with the Qualification type.
|
1079
|
+
#
|
1080
|
+
# This operation does not revoke Qualifications already assigned to
|
1081
|
+
# Workers because the Qualifications might be needed for active HITs. If
|
1082
|
+
# there are any pending requests for the Qualification type, Amazon
|
1083
|
+
# Mechanical Turk rejects those requests. After you delete a
|
1084
|
+
# Qualification type, you can no longer use it to create HITs or HIT
|
1085
|
+
# types.
|
1086
|
+
#
|
1087
|
+
# <note markdown="1"> DeleteQualificationType must wait for all the HITs that use the
|
1088
|
+
# deleted Qualification type to be deleted before completing. It may
|
1089
|
+
# take up to 48 hours before DeleteQualificationType completes and the
|
1090
|
+
# unique name of the Qualification type is available for reuse with
|
1091
|
+
# CreateQualificationType.
|
1092
|
+
#
|
1093
|
+
# </note>
|
1094
|
+
#
|
1095
|
+
# @option params [required, String] :qualification_type_id
|
1096
|
+
# The ID of the QualificationType to dispose.
|
1097
|
+
#
|
1098
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1099
|
+
#
|
1100
|
+
# @example Request syntax with placeholder values
|
1101
|
+
#
|
1102
|
+
# resp = client.delete_qualification_type({
|
1103
|
+
# qualification_type_id: "EntityId", # required
|
1104
|
+
# })
|
1105
|
+
#
|
1106
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mturk-requester-2017-01-17/DeleteQualificationType AWS API Documentation
|
1107
|
+
#
|
1108
|
+
# @overload delete_qualification_type(params = {})
|
1109
|
+
# @param [Hash] params ({})
|
1110
|
+
def delete_qualification_type(params = {}, options = {})
|
1111
|
+
req = build_request(:delete_qualification_type, params)
|
1112
|
+
req.send_request(options)
|
1113
|
+
end
|
1114
|
+
|
1115
|
+
# The `DeleteWorkerBlock` operation allows you to reinstate a blocked
|
1116
|
+
# Worker to work on your HITs. This operation reverses the effects of
|
1117
|
+
# the CreateWorkerBlock operation. You need the Worker ID to use this
|
1118
|
+
# operation. If the Worker ID is missing or invalid, this operation
|
1119
|
+
# fails and returns the message “WorkerId is invalid.” If the specified
|
1120
|
+
# Worker is not blocked, this operation returns successfully.
|
1121
|
+
#
|
1122
|
+
# @option params [required, String] :worker_id
|
1123
|
+
# The ID of the Worker to unblock.
|
1124
|
+
#
|
1125
|
+
# @option params [String] :reason
|
1126
|
+
# A message that explains the reason for unblocking the Worker. The
|
1127
|
+
# Worker does not see this message.
|
1128
|
+
#
|
1129
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1130
|
+
#
|
1131
|
+
# @example Request syntax with placeholder values
|
1132
|
+
#
|
1133
|
+
# resp = client.delete_worker_block({
|
1134
|
+
# worker_id: "CustomerId", # required
|
1135
|
+
# reason: "String",
|
1136
|
+
# })
|
1137
|
+
#
|
1138
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mturk-requester-2017-01-17/DeleteWorkerBlock AWS API Documentation
|
1139
|
+
#
|
1140
|
+
# @overload delete_worker_block(params = {})
|
1141
|
+
# @param [Hash] params ({})
|
1142
|
+
def delete_worker_block(params = {}, options = {})
|
1143
|
+
req = build_request(:delete_worker_block, params)
|
1144
|
+
req.send_request(options)
|
1145
|
+
end
|
1146
|
+
|
1147
|
+
# The `DisassociateQualificationFromWorker` revokes a previously granted
|
1148
|
+
# Qualification from a user.
|
1149
|
+
#
|
1150
|
+
# You can provide a text message explaining why the Qualification was
|
1151
|
+
# revoked. The user who had the Qualification can see this message.
|
1152
|
+
#
|
1153
|
+
# @option params [required, String] :worker_id
|
1154
|
+
# The ID of the Worker who possesses the Qualification to be revoked.
|
1155
|
+
#
|
1156
|
+
# @option params [required, String] :qualification_type_id
|
1157
|
+
# The ID of the Qualification type of the Qualification to be revoked.
|
1158
|
+
#
|
1159
|
+
# @option params [String] :reason
|
1160
|
+
# A text message that explains why the Qualification was revoked. The
|
1161
|
+
# user who had the Qualification sees this message.
|
1162
|
+
#
|
1163
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1164
|
+
#
|
1165
|
+
# @example Request syntax with placeholder values
|
1166
|
+
#
|
1167
|
+
# resp = client.disassociate_qualification_from_worker({
|
1168
|
+
# worker_id: "CustomerId", # required
|
1169
|
+
# qualification_type_id: "EntityId", # required
|
1170
|
+
# reason: "String",
|
1171
|
+
# })
|
1172
|
+
#
|
1173
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mturk-requester-2017-01-17/DisassociateQualificationFromWorker AWS API Documentation
|
1174
|
+
#
|
1175
|
+
# @overload disassociate_qualification_from_worker(params = {})
|
1176
|
+
# @param [Hash] params ({})
|
1177
|
+
def disassociate_qualification_from_worker(params = {}, options = {})
|
1178
|
+
req = build_request(:disassociate_qualification_from_worker, params)
|
1179
|
+
req.send_request(options)
|
1180
|
+
end
|
1181
|
+
|
1182
|
+
# The `GetAccountBalance` operation retrieves the amount of money in
|
1183
|
+
# your Amazon Mechanical Turk account.
|
1184
|
+
#
|
1185
|
+
# @return [Types::GetAccountBalanceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1186
|
+
#
|
1187
|
+
# * {Types::GetAccountBalanceResponse#available_balance #available_balance} => String
|
1188
|
+
# * {Types::GetAccountBalanceResponse#on_hold_balance #on_hold_balance} => String
|
1189
|
+
#
|
1190
|
+
# @example Response structure
|
1191
|
+
#
|
1192
|
+
# resp.available_balance #=> String
|
1193
|
+
# resp.on_hold_balance #=> String
|
1194
|
+
#
|
1195
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mturk-requester-2017-01-17/GetAccountBalance AWS API Documentation
|
1196
|
+
#
|
1197
|
+
# @overload get_account_balance(params = {})
|
1198
|
+
# @param [Hash] params ({})
|
1199
|
+
def get_account_balance(params = {}, options = {})
|
1200
|
+
req = build_request(:get_account_balance, params)
|
1201
|
+
req.send_request(options)
|
1202
|
+
end
|
1203
|
+
|
1204
|
+
# The `GetAssignment` operation retrieves the details of the specified
|
1205
|
+
# Assignment.
|
1206
|
+
#
|
1207
|
+
# @option params [required, String] :assignment_id
|
1208
|
+
# The ID of the Assignment to be retrieved.
|
1209
|
+
#
|
1210
|
+
# @return [Types::GetAssignmentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1211
|
+
#
|
1212
|
+
# * {Types::GetAssignmentResponse#assignment #assignment} => Types::Assignment
|
1213
|
+
# * {Types::GetAssignmentResponse#hit #hit} => Types::HIT
|
1214
|
+
#
|
1215
|
+
# @example Request syntax with placeholder values
|
1216
|
+
#
|
1217
|
+
# resp = client.get_assignment({
|
1218
|
+
# assignment_id: "EntityId", # required
|
1219
|
+
# })
|
1220
|
+
#
|
1221
|
+
# @example Response structure
|
1222
|
+
#
|
1223
|
+
# resp.assignment.assignment_id #=> String
|
1224
|
+
# resp.assignment.worker_id #=> String
|
1225
|
+
# resp.assignment.hit_id #=> String
|
1226
|
+
# resp.assignment.assignment_status #=> String, one of "Submitted", "Approved", "Rejected"
|
1227
|
+
# resp.assignment.auto_approval_time #=> Time
|
1228
|
+
# resp.assignment.accept_time #=> Time
|
1229
|
+
# resp.assignment.submit_time #=> Time
|
1230
|
+
# resp.assignment.approval_time #=> Time
|
1231
|
+
# resp.assignment.rejection_time #=> Time
|
1232
|
+
# resp.assignment.deadline #=> Time
|
1233
|
+
# resp.assignment.answer #=> String
|
1234
|
+
# resp.assignment.requester_feedback #=> String
|
1235
|
+
# resp.hit.hit_id #=> String
|
1236
|
+
# resp.hit.hit_type_id #=> String
|
1237
|
+
# resp.hit.hit_group_id #=> String
|
1238
|
+
# resp.hit.hit_layout_id #=> String
|
1239
|
+
# resp.hit.creation_time #=> Time
|
1240
|
+
# resp.hit.title #=> String
|
1241
|
+
# resp.hit.description #=> String
|
1242
|
+
# resp.hit.question #=> String
|
1243
|
+
# resp.hit.keywords #=> String
|
1244
|
+
# resp.hit.hit_status #=> String, one of "Assignable", "Unassignable", "Reviewable", "Reviewing", "Disposed"
|
1245
|
+
# resp.hit.max_assignments #=> Integer
|
1246
|
+
# resp.hit.reward #=> String
|
1247
|
+
# resp.hit.auto_approval_delay_in_seconds #=> Integer
|
1248
|
+
# resp.hit.expiration #=> Time
|
1249
|
+
# resp.hit.assignment_duration_in_seconds #=> Integer
|
1250
|
+
# resp.hit.requester_annotation #=> String
|
1251
|
+
# resp.hit.qualification_requirements #=> Array
|
1252
|
+
# resp.hit.qualification_requirements[0].qualification_type_id #=> String
|
1253
|
+
# resp.hit.qualification_requirements[0].comparator #=> String, one of "LessThan", "LessThanOrEqualTo", "GreaterThan", "GreaterThanOrEqualTo", "EqualTo", "NotEqualTo", "Exists", "DoesNotExist", "In", "NotIn"
|
1254
|
+
# resp.hit.qualification_requirements[0].integer_values #=> Array
|
1255
|
+
# resp.hit.qualification_requirements[0].integer_values[0] #=> Integer
|
1256
|
+
# resp.hit.qualification_requirements[0].locale_values #=> Array
|
1257
|
+
# resp.hit.qualification_requirements[0].locale_values[0].country #=> String
|
1258
|
+
# resp.hit.qualification_requirements[0].locale_values[0].subdivision #=> String
|
1259
|
+
# resp.hit.qualification_requirements[0].required_to_preview #=> Boolean
|
1260
|
+
# resp.hit.hit_review_status #=> String, one of "NotReviewed", "MarkedForReview", "ReviewedAppropriate", "ReviewedInappropriate"
|
1261
|
+
# resp.hit.number_of_assignments_pending #=> Integer
|
1262
|
+
# resp.hit.number_of_assignments_available #=> Integer
|
1263
|
+
# resp.hit.number_of_assignments_completed #=> Integer
|
1264
|
+
#
|
1265
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mturk-requester-2017-01-17/GetAssignment AWS API Documentation
|
1266
|
+
#
|
1267
|
+
# @overload get_assignment(params = {})
|
1268
|
+
# @param [Hash] params ({})
|
1269
|
+
def get_assignment(params = {}, options = {})
|
1270
|
+
req = build_request(:get_assignment, params)
|
1271
|
+
req.send_request(options)
|
1272
|
+
end
|
1273
|
+
|
1274
|
+
# The `GetFileUploadURL` operation generates and returns a temporary
|
1275
|
+
# URL. You use the temporary URL to retrieve a file uploaded by a Worker
|
1276
|
+
# as an answer to a FileUploadAnswer question for a HIT. The temporary
|
1277
|
+
# URL is generated the instant the GetFileUploadURL operation is called,
|
1278
|
+
# and is valid for 60 seconds. You can get a temporary file upload URL
|
1279
|
+
# any time until the HIT is disposed. After the HIT is disposed, any
|
1280
|
+
# uploaded files are deleted, and cannot be retrieved.
|
1281
|
+
#
|
1282
|
+
# @option params [required, String] :assignment_id
|
1283
|
+
# The ID of the assignment that contains the question with a
|
1284
|
+
# FileUploadAnswer.
|
1285
|
+
#
|
1286
|
+
# @option params [required, String] :question_identifier
|
1287
|
+
# The identifier of the question with a FileUploadAnswer, as specified
|
1288
|
+
# in the QuestionForm of the HIT.
|
1289
|
+
#
|
1290
|
+
# @return [Types::GetFileUploadURLResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1291
|
+
#
|
1292
|
+
# * {Types::GetFileUploadURLResponse#file_upload_url #file_upload_url} => String
|
1293
|
+
#
|
1294
|
+
# @example Request syntax with placeholder values
|
1295
|
+
#
|
1296
|
+
# resp = client.get_file_upload_url({
|
1297
|
+
# assignment_id: "EntityId", # required
|
1298
|
+
# question_identifier: "String", # required
|
1299
|
+
# })
|
1300
|
+
#
|
1301
|
+
# @example Response structure
|
1302
|
+
#
|
1303
|
+
# resp.file_upload_url #=> String
|
1304
|
+
#
|
1305
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mturk-requester-2017-01-17/GetFileUploadURL AWS API Documentation
|
1306
|
+
#
|
1307
|
+
# @overload get_file_upload_url(params = {})
|
1308
|
+
# @param [Hash] params ({})
|
1309
|
+
def get_file_upload_url(params = {}, options = {})
|
1310
|
+
req = build_request(:get_file_upload_url, params)
|
1311
|
+
req.send_request(options)
|
1312
|
+
end
|
1313
|
+
|
1314
|
+
# The `GetHIT` operation retrieves the details of the specified HIT.
|
1315
|
+
#
|
1316
|
+
# @option params [required, String] :hit_id
|
1317
|
+
# The ID of the HIT to be retrieved.
|
1318
|
+
#
|
1319
|
+
# @return [Types::GetHITResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1320
|
+
#
|
1321
|
+
# * {Types::GetHITResponse#hit #hit} => Types::HIT
|
1322
|
+
#
|
1323
|
+
# @example Request syntax with placeholder values
|
1324
|
+
#
|
1325
|
+
# resp = client.get_hit({
|
1326
|
+
# hit_id: "EntityId", # required
|
1327
|
+
# })
|
1328
|
+
#
|
1329
|
+
# @example Response structure
|
1330
|
+
#
|
1331
|
+
# resp.hit.hit_id #=> String
|
1332
|
+
# resp.hit.hit_type_id #=> String
|
1333
|
+
# resp.hit.hit_group_id #=> String
|
1334
|
+
# resp.hit.hit_layout_id #=> String
|
1335
|
+
# resp.hit.creation_time #=> Time
|
1336
|
+
# resp.hit.title #=> String
|
1337
|
+
# resp.hit.description #=> String
|
1338
|
+
# resp.hit.question #=> String
|
1339
|
+
# resp.hit.keywords #=> String
|
1340
|
+
# resp.hit.hit_status #=> String, one of "Assignable", "Unassignable", "Reviewable", "Reviewing", "Disposed"
|
1341
|
+
# resp.hit.max_assignments #=> Integer
|
1342
|
+
# resp.hit.reward #=> String
|
1343
|
+
# resp.hit.auto_approval_delay_in_seconds #=> Integer
|
1344
|
+
# resp.hit.expiration #=> Time
|
1345
|
+
# resp.hit.assignment_duration_in_seconds #=> Integer
|
1346
|
+
# resp.hit.requester_annotation #=> String
|
1347
|
+
# resp.hit.qualification_requirements #=> Array
|
1348
|
+
# resp.hit.qualification_requirements[0].qualification_type_id #=> String
|
1349
|
+
# resp.hit.qualification_requirements[0].comparator #=> String, one of "LessThan", "LessThanOrEqualTo", "GreaterThan", "GreaterThanOrEqualTo", "EqualTo", "NotEqualTo", "Exists", "DoesNotExist", "In", "NotIn"
|
1350
|
+
# resp.hit.qualification_requirements[0].integer_values #=> Array
|
1351
|
+
# resp.hit.qualification_requirements[0].integer_values[0] #=> Integer
|
1352
|
+
# resp.hit.qualification_requirements[0].locale_values #=> Array
|
1353
|
+
# resp.hit.qualification_requirements[0].locale_values[0].country #=> String
|
1354
|
+
# resp.hit.qualification_requirements[0].locale_values[0].subdivision #=> String
|
1355
|
+
# resp.hit.qualification_requirements[0].required_to_preview #=> Boolean
|
1356
|
+
# resp.hit.hit_review_status #=> String, one of "NotReviewed", "MarkedForReview", "ReviewedAppropriate", "ReviewedInappropriate"
|
1357
|
+
# resp.hit.number_of_assignments_pending #=> Integer
|
1358
|
+
# resp.hit.number_of_assignments_available #=> Integer
|
1359
|
+
# resp.hit.number_of_assignments_completed #=> Integer
|
1360
|
+
#
|
1361
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mturk-requester-2017-01-17/GetHIT AWS API Documentation
|
1362
|
+
#
|
1363
|
+
# @overload get_hit(params = {})
|
1364
|
+
# @param [Hash] params ({})
|
1365
|
+
def get_hit(params = {}, options = {})
|
1366
|
+
req = build_request(:get_hit, params)
|
1367
|
+
req.send_request(options)
|
1368
|
+
end
|
1369
|
+
|
1370
|
+
# The `GetQualificationScore` operation returns the value of a Worker's
|
1371
|
+
# Qualification for a given Qualification type.
|
1372
|
+
#
|
1373
|
+
# To get a Worker's Qualification, you must know the Worker's ID. The
|
1374
|
+
# Worker's ID is included in the assignment data returned by the
|
1375
|
+
# `ListAssignmentsForHIT` operation.
|
1376
|
+
#
|
1377
|
+
# Only the owner of a Qualification type can query the value of a
|
1378
|
+
# Worker's Qualification of that type.
|
1379
|
+
#
|
1380
|
+
# @option params [required, String] :qualification_type_id
|
1381
|
+
# The ID of the QualificationType.
|
1382
|
+
#
|
1383
|
+
# @option params [required, String] :worker_id
|
1384
|
+
# The ID of the Worker whose Qualification is being updated.
|
1385
|
+
#
|
1386
|
+
# @return [Types::GetQualificationScoreResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1387
|
+
#
|
1388
|
+
# * {Types::GetQualificationScoreResponse#qualification #qualification} => Types::Qualification
|
1389
|
+
#
|
1390
|
+
# @example Request syntax with placeholder values
|
1391
|
+
#
|
1392
|
+
# resp = client.get_qualification_score({
|
1393
|
+
# qualification_type_id: "EntityId", # required
|
1394
|
+
# worker_id: "CustomerId", # required
|
1395
|
+
# })
|
1396
|
+
#
|
1397
|
+
# @example Response structure
|
1398
|
+
#
|
1399
|
+
# resp.qualification.qualification_type_id #=> String
|
1400
|
+
# resp.qualification.worker_id #=> String
|
1401
|
+
# resp.qualification.grant_time #=> Time
|
1402
|
+
# resp.qualification.integer_value #=> Integer
|
1403
|
+
# resp.qualification.locale_value.country #=> String
|
1404
|
+
# resp.qualification.locale_value.subdivision #=> String
|
1405
|
+
# resp.qualification.status #=> String, one of "Granted", "Revoked"
|
1406
|
+
#
|
1407
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mturk-requester-2017-01-17/GetQualificationScore AWS API Documentation
|
1408
|
+
#
|
1409
|
+
# @overload get_qualification_score(params = {})
|
1410
|
+
# @param [Hash] params ({})
|
1411
|
+
def get_qualification_score(params = {}, options = {})
|
1412
|
+
req = build_request(:get_qualification_score, params)
|
1413
|
+
req.send_request(options)
|
1414
|
+
end
|
1415
|
+
|
1416
|
+
# The `GetQualificationType`operation retrieves information about a
|
1417
|
+
# Qualification type using its ID.
|
1418
|
+
#
|
1419
|
+
# @option params [required, String] :qualification_type_id
|
1420
|
+
# The ID of the QualificationType.
|
1421
|
+
#
|
1422
|
+
# @return [Types::GetQualificationTypeResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1423
|
+
#
|
1424
|
+
# * {Types::GetQualificationTypeResponse#qualification_type #qualification_type} => Types::QualificationType
|
1425
|
+
#
|
1426
|
+
# @example Request syntax with placeholder values
|
1427
|
+
#
|
1428
|
+
# resp = client.get_qualification_type({
|
1429
|
+
# qualification_type_id: "EntityId", # required
|
1430
|
+
# })
|
1431
|
+
#
|
1432
|
+
# @example Response structure
|
1433
|
+
#
|
1434
|
+
# resp.qualification_type.qualification_type_id #=> String
|
1435
|
+
# resp.qualification_type.creation_time #=> Time
|
1436
|
+
# resp.qualification_type.name #=> String
|
1437
|
+
# resp.qualification_type.description #=> String
|
1438
|
+
# resp.qualification_type.keywords #=> String
|
1439
|
+
# resp.qualification_type.qualification_type_status #=> String, one of "Active", "Inactive"
|
1440
|
+
# resp.qualification_type.test #=> String
|
1441
|
+
# resp.qualification_type.test_duration_in_seconds #=> Integer
|
1442
|
+
# resp.qualification_type.answer_key #=> String
|
1443
|
+
# resp.qualification_type.retry_delay_in_seconds #=> Integer
|
1444
|
+
# resp.qualification_type.is_requestable #=> Boolean
|
1445
|
+
# resp.qualification_type.auto_granted #=> Boolean
|
1446
|
+
# resp.qualification_type.auto_granted_value #=> Integer
|
1447
|
+
#
|
1448
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mturk-requester-2017-01-17/GetQualificationType AWS API Documentation
|
1449
|
+
#
|
1450
|
+
# @overload get_qualification_type(params = {})
|
1451
|
+
# @param [Hash] params ({})
|
1452
|
+
def get_qualification_type(params = {}, options = {})
|
1453
|
+
req = build_request(:get_qualification_type, params)
|
1454
|
+
req.send_request(options)
|
1455
|
+
end
|
1456
|
+
|
1457
|
+
# The `ListAssignmentsForHIT` operation retrieves completed assignments
|
1458
|
+
# for a HIT. You can use this operation to retrieve the results for a
|
1459
|
+
# HIT.
|
1460
|
+
#
|
1461
|
+
# You can get assignments for a HIT at any time, even if the HIT is not
|
1462
|
+
# yet Reviewable. If a HIT requested multiple assignments, and has
|
1463
|
+
# received some results but has not yet become Reviewable, you can still
|
1464
|
+
# retrieve the partial results with this operation.
|
1465
|
+
#
|
1466
|
+
# Use the AssignmentStatus parameter to control which set of assignments
|
1467
|
+
# for a HIT are returned. The ListAssignmentsForHIT operation can return
|
1468
|
+
# submitted assignments awaiting approval, or it can return assignments
|
1469
|
+
# that have already been approved or rejected. You can set
|
1470
|
+
# AssignmentStatus=Approved,Rejected to get assignments that have
|
1471
|
+
# already been approved and rejected together in one result set.
|
1472
|
+
#
|
1473
|
+
# Only the Requester who created the HIT can retrieve the assignments
|
1474
|
+
# for that HIT.
|
1475
|
+
#
|
1476
|
+
# Results are sorted and divided into numbered pages and the operation
|
1477
|
+
# returns a single page of results. You can use the parameters of the
|
1478
|
+
# operation to control sorting and pagination.
|
1479
|
+
#
|
1480
|
+
# @option params [required, String] :hit_id
|
1481
|
+
# The ID of the HIT.
|
1482
|
+
#
|
1483
|
+
# @option params [String] :next_token
|
1484
|
+
# Pagination token
|
1485
|
+
#
|
1486
|
+
# @option params [Integer] :max_results
|
1487
|
+
#
|
1488
|
+
# @option params [Array<String>] :assignment_statuses
|
1489
|
+
# The status of the assignments to return: Submitted \| Approved \|
|
1490
|
+
# Rejected
|
1491
|
+
#
|
1492
|
+
# @return [Types::ListAssignmentsForHITResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1493
|
+
#
|
1494
|
+
# * {Types::ListAssignmentsForHITResponse#next_token #next_token} => String
|
1495
|
+
# * {Types::ListAssignmentsForHITResponse#num_results #num_results} => Integer
|
1496
|
+
# * {Types::ListAssignmentsForHITResponse#assignments #assignments} => Array<Types::Assignment>
|
1497
|
+
#
|
1498
|
+
# @example Request syntax with placeholder values
|
1499
|
+
#
|
1500
|
+
# resp = client.list_assignments_for_hit({
|
1501
|
+
# hit_id: "EntityId", # required
|
1502
|
+
# next_token: "PaginationToken",
|
1503
|
+
# max_results: 1,
|
1504
|
+
# assignment_statuses: ["Submitted"], # accepts Submitted, Approved, Rejected
|
1505
|
+
# })
|
1506
|
+
#
|
1507
|
+
# @example Response structure
|
1508
|
+
#
|
1509
|
+
# resp.next_token #=> String
|
1510
|
+
# resp.num_results #=> Integer
|
1511
|
+
# resp.assignments #=> Array
|
1512
|
+
# resp.assignments[0].assignment_id #=> String
|
1513
|
+
# resp.assignments[0].worker_id #=> String
|
1514
|
+
# resp.assignments[0].hit_id #=> String
|
1515
|
+
# resp.assignments[0].assignment_status #=> String, one of "Submitted", "Approved", "Rejected"
|
1516
|
+
# resp.assignments[0].auto_approval_time #=> Time
|
1517
|
+
# resp.assignments[0].accept_time #=> Time
|
1518
|
+
# resp.assignments[0].submit_time #=> Time
|
1519
|
+
# resp.assignments[0].approval_time #=> Time
|
1520
|
+
# resp.assignments[0].rejection_time #=> Time
|
1521
|
+
# resp.assignments[0].deadline #=> Time
|
1522
|
+
# resp.assignments[0].answer #=> String
|
1523
|
+
# resp.assignments[0].requester_feedback #=> String
|
1524
|
+
#
|
1525
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mturk-requester-2017-01-17/ListAssignmentsForHIT AWS API Documentation
|
1526
|
+
#
|
1527
|
+
# @overload list_assignments_for_hit(params = {})
|
1528
|
+
# @param [Hash] params ({})
|
1529
|
+
def list_assignments_for_hit(params = {}, options = {})
|
1530
|
+
req = build_request(:list_assignments_for_hit, params)
|
1531
|
+
req.send_request(options)
|
1532
|
+
end
|
1533
|
+
|
1534
|
+
# The `ListBonusPayments` operation retrieves the amounts of bonuses you
|
1535
|
+
# have paid to Workers for a given HIT or assignment.
|
1536
|
+
#
|
1537
|
+
# @option params [String] :hit_id
|
1538
|
+
# The ID of the HIT associated with the bonus payments to retrieve. If
|
1539
|
+
# not specified, all bonus payments for all assignments for the given
|
1540
|
+
# HIT are returned. Either the HITId parameter or the AssignmentId
|
1541
|
+
# parameter must be specified
|
1542
|
+
#
|
1543
|
+
# @option params [String] :assignment_id
|
1544
|
+
# The ID of the assignment associated with the bonus payments to
|
1545
|
+
# retrieve. If specified, only bonus payments for the given assignment
|
1546
|
+
# are returned. Either the HITId parameter or the AssignmentId parameter
|
1547
|
+
# must be specified
|
1548
|
+
#
|
1549
|
+
# @option params [String] :next_token
|
1550
|
+
# Pagination token
|
1551
|
+
#
|
1552
|
+
# @option params [Integer] :max_results
|
1553
|
+
#
|
1554
|
+
# @return [Types::ListBonusPaymentsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1555
|
+
#
|
1556
|
+
# * {Types::ListBonusPaymentsResponse#num_results #num_results} => Integer
|
1557
|
+
# * {Types::ListBonusPaymentsResponse#next_token #next_token} => String
|
1558
|
+
# * {Types::ListBonusPaymentsResponse#bonus_payments #bonus_payments} => Array<Types::BonusPayment>
|
1559
|
+
#
|
1560
|
+
# @example Request syntax with placeholder values
|
1561
|
+
#
|
1562
|
+
# resp = client.list_bonus_payments({
|
1563
|
+
# hit_id: "EntityId",
|
1564
|
+
# assignment_id: "EntityId",
|
1565
|
+
# next_token: "PaginationToken",
|
1566
|
+
# max_results: 1,
|
1567
|
+
# })
|
1568
|
+
#
|
1569
|
+
# @example Response structure
|
1570
|
+
#
|
1571
|
+
# resp.num_results #=> Integer
|
1572
|
+
# resp.next_token #=> String
|
1573
|
+
# resp.bonus_payments #=> Array
|
1574
|
+
# resp.bonus_payments[0].worker_id #=> String
|
1575
|
+
# resp.bonus_payments[0].bonus_amount #=> String
|
1576
|
+
# resp.bonus_payments[0].assignment_id #=> String
|
1577
|
+
# resp.bonus_payments[0].reason #=> String
|
1578
|
+
# resp.bonus_payments[0].grant_time #=> Time
|
1579
|
+
#
|
1580
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mturk-requester-2017-01-17/ListBonusPayments AWS API Documentation
|
1581
|
+
#
|
1582
|
+
# @overload list_bonus_payments(params = {})
|
1583
|
+
# @param [Hash] params ({})
|
1584
|
+
def list_bonus_payments(params = {}, options = {})
|
1585
|
+
req = build_request(:list_bonus_payments, params)
|
1586
|
+
req.send_request(options)
|
1587
|
+
end
|
1588
|
+
|
1589
|
+
# The `ListHITs` operation returns all of a Requester's HITs. The
|
1590
|
+
# operation returns HITs of any status, except for HITs that have been
|
1591
|
+
# deleted of with the DeleteHIT operation or that have been
|
1592
|
+
# auto-deleted.
|
1593
|
+
#
|
1594
|
+
# @option params [String] :next_token
|
1595
|
+
# Pagination token
|
1596
|
+
#
|
1597
|
+
# @option params [Integer] :max_results
|
1598
|
+
#
|
1599
|
+
# @return [Types::ListHITsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1600
|
+
#
|
1601
|
+
# * {Types::ListHITsResponse#next_token #next_token} => String
|
1602
|
+
# * {Types::ListHITsResponse#num_results #num_results} => Integer
|
1603
|
+
# * {Types::ListHITsResponse#hi_ts #hi_ts} => Array<Types::HIT>
|
1604
|
+
#
|
1605
|
+
# @example Request syntax with placeholder values
|
1606
|
+
#
|
1607
|
+
# resp = client.list_hi_ts({
|
1608
|
+
# next_token: "PaginationToken",
|
1609
|
+
# max_results: 1,
|
1610
|
+
# })
|
1611
|
+
#
|
1612
|
+
# @example Response structure
|
1613
|
+
#
|
1614
|
+
# resp.next_token #=> String
|
1615
|
+
# resp.num_results #=> Integer
|
1616
|
+
# resp.hi_ts #=> Array
|
1617
|
+
# resp.hi_ts[0].hit_id #=> String
|
1618
|
+
# resp.hi_ts[0].hit_type_id #=> String
|
1619
|
+
# resp.hi_ts[0].hit_group_id #=> String
|
1620
|
+
# resp.hi_ts[0].hit_layout_id #=> String
|
1621
|
+
# resp.hi_ts[0].creation_time #=> Time
|
1622
|
+
# resp.hi_ts[0].title #=> String
|
1623
|
+
# resp.hi_ts[0].description #=> String
|
1624
|
+
# resp.hi_ts[0].question #=> String
|
1625
|
+
# resp.hi_ts[0].keywords #=> String
|
1626
|
+
# resp.hi_ts[0].hit_status #=> String, one of "Assignable", "Unassignable", "Reviewable", "Reviewing", "Disposed"
|
1627
|
+
# resp.hi_ts[0].max_assignments #=> Integer
|
1628
|
+
# resp.hi_ts[0].reward #=> String
|
1629
|
+
# resp.hi_ts[0].auto_approval_delay_in_seconds #=> Integer
|
1630
|
+
# resp.hi_ts[0].expiration #=> Time
|
1631
|
+
# resp.hi_ts[0].assignment_duration_in_seconds #=> Integer
|
1632
|
+
# resp.hi_ts[0].requester_annotation #=> String
|
1633
|
+
# resp.hi_ts[0].qualification_requirements #=> Array
|
1634
|
+
# resp.hi_ts[0].qualification_requirements[0].qualification_type_id #=> String
|
1635
|
+
# resp.hi_ts[0].qualification_requirements[0].comparator #=> String, one of "LessThan", "LessThanOrEqualTo", "GreaterThan", "GreaterThanOrEqualTo", "EqualTo", "NotEqualTo", "Exists", "DoesNotExist", "In", "NotIn"
|
1636
|
+
# resp.hi_ts[0].qualification_requirements[0].integer_values #=> Array
|
1637
|
+
# resp.hi_ts[0].qualification_requirements[0].integer_values[0] #=> Integer
|
1638
|
+
# resp.hi_ts[0].qualification_requirements[0].locale_values #=> Array
|
1639
|
+
# resp.hi_ts[0].qualification_requirements[0].locale_values[0].country #=> String
|
1640
|
+
# resp.hi_ts[0].qualification_requirements[0].locale_values[0].subdivision #=> String
|
1641
|
+
# resp.hi_ts[0].qualification_requirements[0].required_to_preview #=> Boolean
|
1642
|
+
# resp.hi_ts[0].hit_review_status #=> String, one of "NotReviewed", "MarkedForReview", "ReviewedAppropriate", "ReviewedInappropriate"
|
1643
|
+
# resp.hi_ts[0].number_of_assignments_pending #=> Integer
|
1644
|
+
# resp.hi_ts[0].number_of_assignments_available #=> Integer
|
1645
|
+
# resp.hi_ts[0].number_of_assignments_completed #=> Integer
|
1646
|
+
#
|
1647
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mturk-requester-2017-01-17/ListHITs AWS API Documentation
|
1648
|
+
#
|
1649
|
+
# @overload list_hi_ts(params = {})
|
1650
|
+
# @param [Hash] params ({})
|
1651
|
+
def list_hi_ts(params = {}, options = {})
|
1652
|
+
req = build_request(:list_hi_ts, params)
|
1653
|
+
req.send_request(options)
|
1654
|
+
end
|
1655
|
+
|
1656
|
+
# The `ListHITsForQualificationType` operation returns the HITs that use
|
1657
|
+
# the given Qualification type for a Qualification requirement. The
|
1658
|
+
# operation returns HITs of any status, except for HITs that have been
|
1659
|
+
# deleted with the `DeleteHIT` operation or that have been auto-deleted.
|
1660
|
+
#
|
1661
|
+
# @option params [required, String] :qualification_type_id
|
1662
|
+
# The ID of the Qualification type to use when querying HITs.
|
1663
|
+
#
|
1664
|
+
# @option params [String] :next_token
|
1665
|
+
# Pagination Token
|
1666
|
+
#
|
1667
|
+
# @option params [Integer] :max_results
|
1668
|
+
# Limit the number of results returned.
|
1669
|
+
#
|
1670
|
+
# @return [Types::ListHITsForQualificationTypeResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1671
|
+
#
|
1672
|
+
# * {Types::ListHITsForQualificationTypeResponse#next_token #next_token} => String
|
1673
|
+
# * {Types::ListHITsForQualificationTypeResponse#num_results #num_results} => Integer
|
1674
|
+
# * {Types::ListHITsForQualificationTypeResponse#hi_ts #hi_ts} => Array<Types::HIT>
|
1675
|
+
#
|
1676
|
+
# @example Request syntax with placeholder values
|
1677
|
+
#
|
1678
|
+
# resp = client.list_hi_ts_for_qualification_type({
|
1679
|
+
# qualification_type_id: "EntityId", # required
|
1680
|
+
# next_token: "PaginationToken",
|
1681
|
+
# max_results: 1,
|
1682
|
+
# })
|
1683
|
+
#
|
1684
|
+
# @example Response structure
|
1685
|
+
#
|
1686
|
+
# resp.next_token #=> String
|
1687
|
+
# resp.num_results #=> Integer
|
1688
|
+
# resp.hi_ts #=> Array
|
1689
|
+
# resp.hi_ts[0].hit_id #=> String
|
1690
|
+
# resp.hi_ts[0].hit_type_id #=> String
|
1691
|
+
# resp.hi_ts[0].hit_group_id #=> String
|
1692
|
+
# resp.hi_ts[0].hit_layout_id #=> String
|
1693
|
+
# resp.hi_ts[0].creation_time #=> Time
|
1694
|
+
# resp.hi_ts[0].title #=> String
|
1695
|
+
# resp.hi_ts[0].description #=> String
|
1696
|
+
# resp.hi_ts[0].question #=> String
|
1697
|
+
# resp.hi_ts[0].keywords #=> String
|
1698
|
+
# resp.hi_ts[0].hit_status #=> String, one of "Assignable", "Unassignable", "Reviewable", "Reviewing", "Disposed"
|
1699
|
+
# resp.hi_ts[0].max_assignments #=> Integer
|
1700
|
+
# resp.hi_ts[0].reward #=> String
|
1701
|
+
# resp.hi_ts[0].auto_approval_delay_in_seconds #=> Integer
|
1702
|
+
# resp.hi_ts[0].expiration #=> Time
|
1703
|
+
# resp.hi_ts[0].assignment_duration_in_seconds #=> Integer
|
1704
|
+
# resp.hi_ts[0].requester_annotation #=> String
|
1705
|
+
# resp.hi_ts[0].qualification_requirements #=> Array
|
1706
|
+
# resp.hi_ts[0].qualification_requirements[0].qualification_type_id #=> String
|
1707
|
+
# resp.hi_ts[0].qualification_requirements[0].comparator #=> String, one of "LessThan", "LessThanOrEqualTo", "GreaterThan", "GreaterThanOrEqualTo", "EqualTo", "NotEqualTo", "Exists", "DoesNotExist", "In", "NotIn"
|
1708
|
+
# resp.hi_ts[0].qualification_requirements[0].integer_values #=> Array
|
1709
|
+
# resp.hi_ts[0].qualification_requirements[0].integer_values[0] #=> Integer
|
1710
|
+
# resp.hi_ts[0].qualification_requirements[0].locale_values #=> Array
|
1711
|
+
# resp.hi_ts[0].qualification_requirements[0].locale_values[0].country #=> String
|
1712
|
+
# resp.hi_ts[0].qualification_requirements[0].locale_values[0].subdivision #=> String
|
1713
|
+
# resp.hi_ts[0].qualification_requirements[0].required_to_preview #=> Boolean
|
1714
|
+
# resp.hi_ts[0].hit_review_status #=> String, one of "NotReviewed", "MarkedForReview", "ReviewedAppropriate", "ReviewedInappropriate"
|
1715
|
+
# resp.hi_ts[0].number_of_assignments_pending #=> Integer
|
1716
|
+
# resp.hi_ts[0].number_of_assignments_available #=> Integer
|
1717
|
+
# resp.hi_ts[0].number_of_assignments_completed #=> Integer
|
1718
|
+
#
|
1719
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mturk-requester-2017-01-17/ListHITsForQualificationType AWS API Documentation
|
1720
|
+
#
|
1721
|
+
# @overload list_hi_ts_for_qualification_type(params = {})
|
1722
|
+
# @param [Hash] params ({})
|
1723
|
+
def list_hi_ts_for_qualification_type(params = {}, options = {})
|
1724
|
+
req = build_request(:list_hi_ts_for_qualification_type, params)
|
1725
|
+
req.send_request(options)
|
1726
|
+
end
|
1727
|
+
|
1728
|
+
# The `ListQualificationRequests` operation retrieves requests for
|
1729
|
+
# Qualifications of a particular Qualification type. The owner of the
|
1730
|
+
# Qualification type calls this operation to poll for pending requests,
|
1731
|
+
# and accepts them using the AcceptQualification operation.
|
1732
|
+
#
|
1733
|
+
# @option params [String] :qualification_type_id
|
1734
|
+
# The ID of the QualificationType.
|
1735
|
+
#
|
1736
|
+
# @option params [String] :next_token
|
1737
|
+
# If the previous response was incomplete (because there is more data to
|
1738
|
+
# retrieve), Amazon Mechanical Turk returns a pagination token in the
|
1739
|
+
# response. You can use this pagination token to retrieve the next set
|
1740
|
+
# of results.
|
1741
|
+
#
|
1742
|
+
# @option params [Integer] :max_results
|
1743
|
+
# The maximum number of results to return in a single call.
|
1744
|
+
#
|
1745
|
+
# @return [Types::ListQualificationRequestsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1746
|
+
#
|
1747
|
+
# * {Types::ListQualificationRequestsResponse#num_results #num_results} => Integer
|
1748
|
+
# * {Types::ListQualificationRequestsResponse#next_token #next_token} => String
|
1749
|
+
# * {Types::ListQualificationRequestsResponse#qualification_requests #qualification_requests} => Array<Types::QualificationRequest>
|
1750
|
+
#
|
1751
|
+
# @example Request syntax with placeholder values
|
1752
|
+
#
|
1753
|
+
# resp = client.list_qualification_requests({
|
1754
|
+
# qualification_type_id: "EntityId",
|
1755
|
+
# next_token: "PaginationToken",
|
1756
|
+
# max_results: 1,
|
1757
|
+
# })
|
1758
|
+
#
|
1759
|
+
# @example Response structure
|
1760
|
+
#
|
1761
|
+
# resp.num_results #=> Integer
|
1762
|
+
# resp.next_token #=> String
|
1763
|
+
# resp.qualification_requests #=> Array
|
1764
|
+
# resp.qualification_requests[0].qualification_request_id #=> String
|
1765
|
+
# resp.qualification_requests[0].qualification_type_id #=> String
|
1766
|
+
# resp.qualification_requests[0].worker_id #=> String
|
1767
|
+
# resp.qualification_requests[0].test #=> String
|
1768
|
+
# resp.qualification_requests[0].answer #=> String
|
1769
|
+
# resp.qualification_requests[0].submit_time #=> Time
|
1770
|
+
#
|
1771
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mturk-requester-2017-01-17/ListQualificationRequests AWS API Documentation
|
1772
|
+
#
|
1773
|
+
# @overload list_qualification_requests(params = {})
|
1774
|
+
# @param [Hash] params ({})
|
1775
|
+
def list_qualification_requests(params = {}, options = {})
|
1776
|
+
req = build_request(:list_qualification_requests, params)
|
1777
|
+
req.send_request(options)
|
1778
|
+
end
|
1779
|
+
|
1780
|
+
# The `ListQualificationRequests` operation retrieves requests for
|
1781
|
+
# Qualifications of a particular Qualification type. The owner of the
|
1782
|
+
# Qualification type calls this operation to poll for pending requests,
|
1783
|
+
# and accepts them using the AcceptQualification operation.
|
1784
|
+
#
|
1785
|
+
# @option params [String] :query
|
1786
|
+
# A text query against all of the searchable attributes of Qualification
|
1787
|
+
# types.
|
1788
|
+
#
|
1789
|
+
# @option params [required, Boolean] :must_be_requestable
|
1790
|
+
# Specifies that only Qualification types that a user can request
|
1791
|
+
# through the Amazon Mechanical Turk web site, such as by taking a
|
1792
|
+
# Qualification test, are returned as results of the search. Some
|
1793
|
+
# Qualification types, such as those assigned automatically by the
|
1794
|
+
# system, cannot be requested directly by users. If false, all
|
1795
|
+
# Qualification types, including those managed by the system, are
|
1796
|
+
# considered. Valid values are True \| False.
|
1797
|
+
#
|
1798
|
+
# @option params [Boolean] :must_be_owned_by_caller
|
1799
|
+
# Specifies that only Qualification types that the Requester created are
|
1800
|
+
# returned. If false, the operation returns all Qualification types.
|
1801
|
+
#
|
1802
|
+
# @option params [String] :next_token
|
1803
|
+
# If the previous response was incomplete (because there is more data to
|
1804
|
+
# retrieve), Amazon Mechanical Turk returns a pagination token in the
|
1805
|
+
# response. You can use this pagination token to retrieve the next set
|
1806
|
+
# of results.
|
1807
|
+
#
|
1808
|
+
# @option params [Integer] :max_results
|
1809
|
+
# The maximum number of results to return in a single call.
|
1810
|
+
#
|
1811
|
+
# @return [Types::ListQualificationTypesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1812
|
+
#
|
1813
|
+
# * {Types::ListQualificationTypesResponse#num_results #num_results} => Integer
|
1814
|
+
# * {Types::ListQualificationTypesResponse#next_token #next_token} => String
|
1815
|
+
# * {Types::ListQualificationTypesResponse#qualification_types #qualification_types} => Array<Types::QualificationType>
|
1816
|
+
#
|
1817
|
+
# @example Request syntax with placeholder values
|
1818
|
+
#
|
1819
|
+
# resp = client.list_qualification_types({
|
1820
|
+
# query: "String",
|
1821
|
+
# must_be_requestable: false, # required
|
1822
|
+
# must_be_owned_by_caller: false,
|
1823
|
+
# next_token: "PaginationToken",
|
1824
|
+
# max_results: 1,
|
1825
|
+
# })
|
1826
|
+
#
|
1827
|
+
# @example Response structure
|
1828
|
+
#
|
1829
|
+
# resp.num_results #=> Integer
|
1830
|
+
# resp.next_token #=> String
|
1831
|
+
# resp.qualification_types #=> Array
|
1832
|
+
# resp.qualification_types[0].qualification_type_id #=> String
|
1833
|
+
# resp.qualification_types[0].creation_time #=> Time
|
1834
|
+
# resp.qualification_types[0].name #=> String
|
1835
|
+
# resp.qualification_types[0].description #=> String
|
1836
|
+
# resp.qualification_types[0].keywords #=> String
|
1837
|
+
# resp.qualification_types[0].qualification_type_status #=> String, one of "Active", "Inactive"
|
1838
|
+
# resp.qualification_types[0].test #=> String
|
1839
|
+
# resp.qualification_types[0].test_duration_in_seconds #=> Integer
|
1840
|
+
# resp.qualification_types[0].answer_key #=> String
|
1841
|
+
# resp.qualification_types[0].retry_delay_in_seconds #=> Integer
|
1842
|
+
# resp.qualification_types[0].is_requestable #=> Boolean
|
1843
|
+
# resp.qualification_types[0].auto_granted #=> Boolean
|
1844
|
+
# resp.qualification_types[0].auto_granted_value #=> Integer
|
1845
|
+
#
|
1846
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mturk-requester-2017-01-17/ListQualificationTypes AWS API Documentation
|
1847
|
+
#
|
1848
|
+
# @overload list_qualification_types(params = {})
|
1849
|
+
# @param [Hash] params ({})
|
1850
|
+
def list_qualification_types(params = {}, options = {})
|
1851
|
+
req = build_request(:list_qualification_types, params)
|
1852
|
+
req.send_request(options)
|
1853
|
+
end
|
1854
|
+
|
1855
|
+
# The `ListReviewPolicyResultsForHIT` operation retrieves the computed
|
1856
|
+
# results and the actions taken in the course of executing your Review
|
1857
|
+
# Policies for a given HIT. For information about how to specify Review
|
1858
|
+
# Policies when you call CreateHIT, see Review Policies. The
|
1859
|
+
# ListReviewPolicyResultsForHIT operation can return results for both
|
1860
|
+
# Assignment-level and HIT-level review results.
|
1861
|
+
#
|
1862
|
+
# @option params [required, String] :hit_id
|
1863
|
+
# The unique identifier of the HIT to retrieve review results for.
|
1864
|
+
#
|
1865
|
+
# @option params [Array<String>] :policy_levels
|
1866
|
+
# The Policy Level(s) to retrieve review results for - HIT or
|
1867
|
+
# Assignment. If omitted, the default behavior is to retrieve all data
|
1868
|
+
# for both policy levels. For a list of all the described policies, see
|
1869
|
+
# Review Policies.
|
1870
|
+
#
|
1871
|
+
# @option params [Boolean] :retrieve_actions
|
1872
|
+
# Specify if the operation should retrieve a list of the actions taken
|
1873
|
+
# executing the Review Policies and their outcomes.
|
1874
|
+
#
|
1875
|
+
# @option params [Boolean] :retrieve_results
|
1876
|
+
# Specify if the operation should retrieve a list of the results
|
1877
|
+
# computed by the Review Policies.
|
1878
|
+
#
|
1879
|
+
# @option params [String] :next_token
|
1880
|
+
# Pagination token
|
1881
|
+
#
|
1882
|
+
# @option params [Integer] :max_results
|
1883
|
+
# Limit the number of results returned.
|
1884
|
+
#
|
1885
|
+
# @return [Types::ListReviewPolicyResultsForHITResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1886
|
+
#
|
1887
|
+
# * {Types::ListReviewPolicyResultsForHITResponse#hit_id #hit_id} => String
|
1888
|
+
# * {Types::ListReviewPolicyResultsForHITResponse#assignment_review_policy #assignment_review_policy} => Types::ReviewPolicy
|
1889
|
+
# * {Types::ListReviewPolicyResultsForHITResponse#hit_review_policy #hit_review_policy} => Types::ReviewPolicy
|
1890
|
+
# * {Types::ListReviewPolicyResultsForHITResponse#assignment_review_report #assignment_review_report} => Types::ReviewReport
|
1891
|
+
# * {Types::ListReviewPolicyResultsForHITResponse#hit_review_report #hit_review_report} => Types::ReviewReport
|
1892
|
+
# * {Types::ListReviewPolicyResultsForHITResponse#next_token #next_token} => String
|
1893
|
+
#
|
1894
|
+
# @example Request syntax with placeholder values
|
1895
|
+
#
|
1896
|
+
# resp = client.list_review_policy_results_for_hit({
|
1897
|
+
# hit_id: "EntityId", # required
|
1898
|
+
# policy_levels: ["Assignment"], # accepts Assignment, HIT
|
1899
|
+
# retrieve_actions: false,
|
1900
|
+
# retrieve_results: false,
|
1901
|
+
# next_token: "PaginationToken",
|
1902
|
+
# max_results: 1,
|
1903
|
+
# })
|
1904
|
+
#
|
1905
|
+
# @example Response structure
|
1906
|
+
#
|
1907
|
+
# resp.hit_id #=> String
|
1908
|
+
# resp.assignment_review_policy.policy_name #=> String
|
1909
|
+
# resp.assignment_review_policy.parameters #=> Array
|
1910
|
+
# resp.assignment_review_policy.parameters[0].key #=> String
|
1911
|
+
# resp.assignment_review_policy.parameters[0].values #=> Array
|
1912
|
+
# resp.assignment_review_policy.parameters[0].values[0] #=> String
|
1913
|
+
# resp.assignment_review_policy.parameters[0].map_entries #=> Array
|
1914
|
+
# resp.assignment_review_policy.parameters[0].map_entries[0].key #=> String
|
1915
|
+
# resp.assignment_review_policy.parameters[0].map_entries[0].values #=> Array
|
1916
|
+
# resp.assignment_review_policy.parameters[0].map_entries[0].values[0] #=> String
|
1917
|
+
# resp.hit_review_policy.policy_name #=> String
|
1918
|
+
# resp.hit_review_policy.parameters #=> Array
|
1919
|
+
# resp.hit_review_policy.parameters[0].key #=> String
|
1920
|
+
# resp.hit_review_policy.parameters[0].values #=> Array
|
1921
|
+
# resp.hit_review_policy.parameters[0].values[0] #=> String
|
1922
|
+
# resp.hit_review_policy.parameters[0].map_entries #=> Array
|
1923
|
+
# resp.hit_review_policy.parameters[0].map_entries[0].key #=> String
|
1924
|
+
# resp.hit_review_policy.parameters[0].map_entries[0].values #=> Array
|
1925
|
+
# resp.hit_review_policy.parameters[0].map_entries[0].values[0] #=> String
|
1926
|
+
# resp.assignment_review_report.review_results #=> Array
|
1927
|
+
# resp.assignment_review_report.review_results[0].action_id #=> String
|
1928
|
+
# resp.assignment_review_report.review_results[0].subject_id #=> String
|
1929
|
+
# resp.assignment_review_report.review_results[0].subject_type #=> String
|
1930
|
+
# resp.assignment_review_report.review_results[0].question_id #=> String
|
1931
|
+
# resp.assignment_review_report.review_results[0].key #=> String
|
1932
|
+
# resp.assignment_review_report.review_results[0].value #=> String
|
1933
|
+
# resp.assignment_review_report.review_actions #=> Array
|
1934
|
+
# resp.assignment_review_report.review_actions[0].action_id #=> String
|
1935
|
+
# resp.assignment_review_report.review_actions[0].action_name #=> String
|
1936
|
+
# resp.assignment_review_report.review_actions[0].target_id #=> String
|
1937
|
+
# resp.assignment_review_report.review_actions[0].target_type #=> String
|
1938
|
+
# resp.assignment_review_report.review_actions[0].status #=> String, one of "Intended", "Succeeded", "Failed", "Cancelled"
|
1939
|
+
# resp.assignment_review_report.review_actions[0].complete_time #=> Time
|
1940
|
+
# resp.assignment_review_report.review_actions[0].result #=> String
|
1941
|
+
# resp.assignment_review_report.review_actions[0].error_code #=> String
|
1942
|
+
# resp.hit_review_report.review_results #=> Array
|
1943
|
+
# resp.hit_review_report.review_results[0].action_id #=> String
|
1944
|
+
# resp.hit_review_report.review_results[0].subject_id #=> String
|
1945
|
+
# resp.hit_review_report.review_results[0].subject_type #=> String
|
1946
|
+
# resp.hit_review_report.review_results[0].question_id #=> String
|
1947
|
+
# resp.hit_review_report.review_results[0].key #=> String
|
1948
|
+
# resp.hit_review_report.review_results[0].value #=> String
|
1949
|
+
# resp.hit_review_report.review_actions #=> Array
|
1950
|
+
# resp.hit_review_report.review_actions[0].action_id #=> String
|
1951
|
+
# resp.hit_review_report.review_actions[0].action_name #=> String
|
1952
|
+
# resp.hit_review_report.review_actions[0].target_id #=> String
|
1953
|
+
# resp.hit_review_report.review_actions[0].target_type #=> String
|
1954
|
+
# resp.hit_review_report.review_actions[0].status #=> String, one of "Intended", "Succeeded", "Failed", "Cancelled"
|
1955
|
+
# resp.hit_review_report.review_actions[0].complete_time #=> Time
|
1956
|
+
# resp.hit_review_report.review_actions[0].result #=> String
|
1957
|
+
# resp.hit_review_report.review_actions[0].error_code #=> String
|
1958
|
+
# resp.next_token #=> String
|
1959
|
+
#
|
1960
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mturk-requester-2017-01-17/ListReviewPolicyResultsForHIT AWS API Documentation
|
1961
|
+
#
|
1962
|
+
# @overload list_review_policy_results_for_hit(params = {})
|
1963
|
+
# @param [Hash] params ({})
|
1964
|
+
def list_review_policy_results_for_hit(params = {}, options = {})
|
1965
|
+
req = build_request(:list_review_policy_results_for_hit, params)
|
1966
|
+
req.send_request(options)
|
1967
|
+
end
|
1968
|
+
|
1969
|
+
# The `ListReviewableHITs` operation retrieves the HITs with Status
|
1970
|
+
# equal to Reviewable or Status equal to Reviewing that belong to the
|
1971
|
+
# Requester calling the operation.
|
1972
|
+
#
|
1973
|
+
# @option params [String] :hit_type_id
|
1974
|
+
# The ID of the HIT type of the HITs to consider for the query. If not
|
1975
|
+
# specified, all HITs for the Reviewer are considered
|
1976
|
+
#
|
1977
|
+
# @option params [String] :status
|
1978
|
+
# Can be either `Reviewable` or `Reviewing`. Reviewable is the default
|
1979
|
+
# value.
|
1980
|
+
#
|
1981
|
+
# @option params [String] :next_token
|
1982
|
+
# Pagination Token
|
1983
|
+
#
|
1984
|
+
# @option params [Integer] :max_results
|
1985
|
+
# Limit the number of results returned.
|
1986
|
+
#
|
1987
|
+
# @return [Types::ListReviewableHITsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1988
|
+
#
|
1989
|
+
# * {Types::ListReviewableHITsResponse#next_token #next_token} => String
|
1990
|
+
# * {Types::ListReviewableHITsResponse#num_results #num_results} => Integer
|
1991
|
+
# * {Types::ListReviewableHITsResponse#hi_ts #hi_ts} => Array<Types::HIT>
|
1992
|
+
#
|
1993
|
+
# @example Request syntax with placeholder values
|
1994
|
+
#
|
1995
|
+
# resp = client.list_reviewable_hi_ts({
|
1996
|
+
# hit_type_id: "EntityId",
|
1997
|
+
# status: "Reviewable", # accepts Reviewable, Reviewing
|
1998
|
+
# next_token: "PaginationToken",
|
1999
|
+
# max_results: 1,
|
2000
|
+
# })
|
2001
|
+
#
|
2002
|
+
# @example Response structure
|
2003
|
+
#
|
2004
|
+
# resp.next_token #=> String
|
2005
|
+
# resp.num_results #=> Integer
|
2006
|
+
# resp.hi_ts #=> Array
|
2007
|
+
# resp.hi_ts[0].hit_id #=> String
|
2008
|
+
# resp.hi_ts[0].hit_type_id #=> String
|
2009
|
+
# resp.hi_ts[0].hit_group_id #=> String
|
2010
|
+
# resp.hi_ts[0].hit_layout_id #=> String
|
2011
|
+
# resp.hi_ts[0].creation_time #=> Time
|
2012
|
+
# resp.hi_ts[0].title #=> String
|
2013
|
+
# resp.hi_ts[0].description #=> String
|
2014
|
+
# resp.hi_ts[0].question #=> String
|
2015
|
+
# resp.hi_ts[0].keywords #=> String
|
2016
|
+
# resp.hi_ts[0].hit_status #=> String, one of "Assignable", "Unassignable", "Reviewable", "Reviewing", "Disposed"
|
2017
|
+
# resp.hi_ts[0].max_assignments #=> Integer
|
2018
|
+
# resp.hi_ts[0].reward #=> String
|
2019
|
+
# resp.hi_ts[0].auto_approval_delay_in_seconds #=> Integer
|
2020
|
+
# resp.hi_ts[0].expiration #=> Time
|
2021
|
+
# resp.hi_ts[0].assignment_duration_in_seconds #=> Integer
|
2022
|
+
# resp.hi_ts[0].requester_annotation #=> String
|
2023
|
+
# resp.hi_ts[0].qualification_requirements #=> Array
|
2024
|
+
# resp.hi_ts[0].qualification_requirements[0].qualification_type_id #=> String
|
2025
|
+
# resp.hi_ts[0].qualification_requirements[0].comparator #=> String, one of "LessThan", "LessThanOrEqualTo", "GreaterThan", "GreaterThanOrEqualTo", "EqualTo", "NotEqualTo", "Exists", "DoesNotExist", "In", "NotIn"
|
2026
|
+
# resp.hi_ts[0].qualification_requirements[0].integer_values #=> Array
|
2027
|
+
# resp.hi_ts[0].qualification_requirements[0].integer_values[0] #=> Integer
|
2028
|
+
# resp.hi_ts[0].qualification_requirements[0].locale_values #=> Array
|
2029
|
+
# resp.hi_ts[0].qualification_requirements[0].locale_values[0].country #=> String
|
2030
|
+
# resp.hi_ts[0].qualification_requirements[0].locale_values[0].subdivision #=> String
|
2031
|
+
# resp.hi_ts[0].qualification_requirements[0].required_to_preview #=> Boolean
|
2032
|
+
# resp.hi_ts[0].hit_review_status #=> String, one of "NotReviewed", "MarkedForReview", "ReviewedAppropriate", "ReviewedInappropriate"
|
2033
|
+
# resp.hi_ts[0].number_of_assignments_pending #=> Integer
|
2034
|
+
# resp.hi_ts[0].number_of_assignments_available #=> Integer
|
2035
|
+
# resp.hi_ts[0].number_of_assignments_completed #=> Integer
|
2036
|
+
#
|
2037
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mturk-requester-2017-01-17/ListReviewableHITs AWS API Documentation
|
2038
|
+
#
|
2039
|
+
# @overload list_reviewable_hi_ts(params = {})
|
2040
|
+
# @param [Hash] params ({})
|
2041
|
+
def list_reviewable_hi_ts(params = {}, options = {})
|
2042
|
+
req = build_request(:list_reviewable_hi_ts, params)
|
2043
|
+
req.send_request(options)
|
2044
|
+
end
|
2045
|
+
|
2046
|
+
# The `ListWorkersBlocks` operation retrieves a list of Workers who are
|
2047
|
+
# blocked from working on your HITs.
|
2048
|
+
#
|
2049
|
+
# @option params [String] :next_token
|
2050
|
+
# Pagination token
|
2051
|
+
#
|
2052
|
+
# @option params [Integer] :max_results
|
2053
|
+
#
|
2054
|
+
# @return [Types::ListWorkerBlocksResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2055
|
+
#
|
2056
|
+
# * {Types::ListWorkerBlocksResponse#next_token #next_token} => String
|
2057
|
+
# * {Types::ListWorkerBlocksResponse#num_results #num_results} => Integer
|
2058
|
+
# * {Types::ListWorkerBlocksResponse#worker_blocks #worker_blocks} => Array<Types::WorkerBlock>
|
2059
|
+
#
|
2060
|
+
# @example Request syntax with placeholder values
|
2061
|
+
#
|
2062
|
+
# resp = client.list_worker_blocks({
|
2063
|
+
# next_token: "PaginationToken",
|
2064
|
+
# max_results: 1,
|
2065
|
+
# })
|
2066
|
+
#
|
2067
|
+
# @example Response structure
|
2068
|
+
#
|
2069
|
+
# resp.next_token #=> String
|
2070
|
+
# resp.num_results #=> Integer
|
2071
|
+
# resp.worker_blocks #=> Array
|
2072
|
+
# resp.worker_blocks[0].worker_id #=> String
|
2073
|
+
# resp.worker_blocks[0].reason #=> String
|
2074
|
+
#
|
2075
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mturk-requester-2017-01-17/ListWorkerBlocks AWS API Documentation
|
2076
|
+
#
|
2077
|
+
# @overload list_worker_blocks(params = {})
|
2078
|
+
# @param [Hash] params ({})
|
2079
|
+
def list_worker_blocks(params = {}, options = {})
|
2080
|
+
req = build_request(:list_worker_blocks, params)
|
2081
|
+
req.send_request(options)
|
2082
|
+
end
|
2083
|
+
|
2084
|
+
# The `ListWorkersWithQualificationType` operation returns all of the
|
2085
|
+
# Workers that have been associated with a given Qualification type.
|
2086
|
+
#
|
2087
|
+
# @option params [required, String] :qualification_type_id
|
2088
|
+
# The ID of the Qualification type of the Qualifications to return.
|
2089
|
+
#
|
2090
|
+
# @option params [String] :status
|
2091
|
+
# The status of the Qualifications to return. Can be `Granted |
|
2092
|
+
# Revoked`.
|
2093
|
+
#
|
2094
|
+
# @option params [String] :next_token
|
2095
|
+
# Pagination Token
|
2096
|
+
#
|
2097
|
+
# @option params [Integer] :max_results
|
2098
|
+
# Limit the number of results returned.
|
2099
|
+
#
|
2100
|
+
# @return [Types::ListWorkersWithQualificationTypeResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2101
|
+
#
|
2102
|
+
# * {Types::ListWorkersWithQualificationTypeResponse#next_token #next_token} => String
|
2103
|
+
# * {Types::ListWorkersWithQualificationTypeResponse#num_results #num_results} => Integer
|
2104
|
+
# * {Types::ListWorkersWithQualificationTypeResponse#qualifications #qualifications} => Array<Types::Qualification>
|
2105
|
+
#
|
2106
|
+
# @example Request syntax with placeholder values
|
2107
|
+
#
|
2108
|
+
# resp = client.list_workers_with_qualification_type({
|
2109
|
+
# qualification_type_id: "EntityId", # required
|
2110
|
+
# status: "Granted", # accepts Granted, Revoked
|
2111
|
+
# next_token: "PaginationToken",
|
2112
|
+
# max_results: 1,
|
2113
|
+
# })
|
2114
|
+
#
|
2115
|
+
# @example Response structure
|
2116
|
+
#
|
2117
|
+
# resp.next_token #=> String
|
2118
|
+
# resp.num_results #=> Integer
|
2119
|
+
# resp.qualifications #=> Array
|
2120
|
+
# resp.qualifications[0].qualification_type_id #=> String
|
2121
|
+
# resp.qualifications[0].worker_id #=> String
|
2122
|
+
# resp.qualifications[0].grant_time #=> Time
|
2123
|
+
# resp.qualifications[0].integer_value #=> Integer
|
2124
|
+
# resp.qualifications[0].locale_value.country #=> String
|
2125
|
+
# resp.qualifications[0].locale_value.subdivision #=> String
|
2126
|
+
# resp.qualifications[0].status #=> String, one of "Granted", "Revoked"
|
2127
|
+
#
|
2128
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mturk-requester-2017-01-17/ListWorkersWithQualificationType AWS API Documentation
|
2129
|
+
#
|
2130
|
+
# @overload list_workers_with_qualification_type(params = {})
|
2131
|
+
# @param [Hash] params ({})
|
2132
|
+
def list_workers_with_qualification_type(params = {}, options = {})
|
2133
|
+
req = build_request(:list_workers_with_qualification_type, params)
|
2134
|
+
req.send_request(options)
|
2135
|
+
end
|
2136
|
+
|
2137
|
+
# The `NotifyWorkers` operation sends an email to one or more Workers
|
2138
|
+
# that you specify with the Worker ID. You can specify up to 100 Worker
|
2139
|
+
# IDs to send the same message with a single call to the NotifyWorkers
|
2140
|
+
# operation. The NotifyWorkers operation will send a notification email
|
2141
|
+
# to a Worker only if you have previously approved or rejected work from
|
2142
|
+
# the Worker.
|
2143
|
+
#
|
2144
|
+
# @option params [required, String] :subject
|
2145
|
+
# The subject line of the email message to send. Can include up to 200
|
2146
|
+
# characters.
|
2147
|
+
#
|
2148
|
+
# @option params [required, String] :message_text
|
2149
|
+
# The text of the email message to send. Can include up to 4,096
|
2150
|
+
# characters
|
2151
|
+
#
|
2152
|
+
# @option params [required, Array<String>] :worker_ids
|
2153
|
+
# A list of Worker IDs you wish to notify. You can notify upto 100
|
2154
|
+
# Workers at a time.
|
2155
|
+
#
|
2156
|
+
# @return [Types::NotifyWorkersResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2157
|
+
#
|
2158
|
+
# * {Types::NotifyWorkersResponse#notify_workers_failure_statuses #notify_workers_failure_statuses} => Array<Types::NotifyWorkersFailureStatus>
|
2159
|
+
#
|
2160
|
+
# @example Request syntax with placeholder values
|
2161
|
+
#
|
2162
|
+
# resp = client.notify_workers({
|
2163
|
+
# subject: "String", # required
|
2164
|
+
# message_text: "String", # required
|
2165
|
+
# worker_ids: ["CustomerId"], # required
|
2166
|
+
# })
|
2167
|
+
#
|
2168
|
+
# @example Response structure
|
2169
|
+
#
|
2170
|
+
# resp.notify_workers_failure_statuses #=> Array
|
2171
|
+
# resp.notify_workers_failure_statuses[0].notify_workers_failure_code #=> String, one of "SoftFailure", "HardFailure"
|
2172
|
+
# resp.notify_workers_failure_statuses[0].notify_workers_failure_message #=> String
|
2173
|
+
# resp.notify_workers_failure_statuses[0].worker_id #=> String
|
2174
|
+
#
|
2175
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mturk-requester-2017-01-17/NotifyWorkers AWS API Documentation
|
2176
|
+
#
|
2177
|
+
# @overload notify_workers(params = {})
|
2178
|
+
# @param [Hash] params ({})
|
2179
|
+
def notify_workers(params = {}, options = {})
|
2180
|
+
req = build_request(:notify_workers, params)
|
2181
|
+
req.send_request(options)
|
2182
|
+
end
|
2183
|
+
|
2184
|
+
# The `RejectAssignment` operation rejects the results of a completed
|
2185
|
+
# assignment.
|
2186
|
+
#
|
2187
|
+
# You can include an optional feedback message with the rejection, which
|
2188
|
+
# the Worker can see in the Status section of the web site. When you
|
2189
|
+
# include a feedback message with the rejection, it helps the Worker
|
2190
|
+
# understand why the assignment was rejected, and can improve the
|
2191
|
+
# quality of the results the Worker submits in the future.
|
2192
|
+
#
|
2193
|
+
# Only the Requester who created the HIT can reject an assignment for
|
2194
|
+
# the HIT.
|
2195
|
+
#
|
2196
|
+
# @option params [required, String] :assignment_id
|
2197
|
+
# The ID of the assignment. The assignment must correspond to a HIT
|
2198
|
+
# created by the Requester.
|
2199
|
+
#
|
2200
|
+
# @option params [String] :requester_feedback
|
2201
|
+
# A message for the Worker, which the Worker can see in the Status
|
2202
|
+
# section of the web site.
|
2203
|
+
#
|
2204
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2205
|
+
#
|
2206
|
+
# @example Request syntax with placeholder values
|
2207
|
+
#
|
2208
|
+
# resp = client.reject_assignment({
|
2209
|
+
# assignment_id: "EntityId", # required
|
2210
|
+
# requester_feedback: "String",
|
2211
|
+
# })
|
2212
|
+
#
|
2213
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mturk-requester-2017-01-17/RejectAssignment AWS API Documentation
|
2214
|
+
#
|
2215
|
+
# @overload reject_assignment(params = {})
|
2216
|
+
# @param [Hash] params ({})
|
2217
|
+
def reject_assignment(params = {}, options = {})
|
2218
|
+
req = build_request(:reject_assignment, params)
|
2219
|
+
req.send_request(options)
|
2220
|
+
end
|
2221
|
+
|
2222
|
+
# The `RejectQualificationRequest` operation rejects a user's request
|
2223
|
+
# for a Qualification.
|
2224
|
+
#
|
2225
|
+
# You can provide a text message explaining why the request was
|
2226
|
+
# rejected. The Worker who made the request can see this message.
|
2227
|
+
#
|
2228
|
+
# @option params [required, String] :qualification_request_id
|
2229
|
+
# The ID of the Qualification request, as returned by the
|
2230
|
+
# `ListQualificationRequests` operation.
|
2231
|
+
#
|
2232
|
+
# @option params [String] :reason
|
2233
|
+
# A text message explaining why the request was rejected, to be shown to
|
2234
|
+
# the Worker who made the request.
|
2235
|
+
#
|
2236
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2237
|
+
#
|
2238
|
+
# @example Request syntax with placeholder values
|
2239
|
+
#
|
2240
|
+
# resp = client.reject_qualification_request({
|
2241
|
+
# qualification_request_id: "String", # required
|
2242
|
+
# reason: "String",
|
2243
|
+
# })
|
2244
|
+
#
|
2245
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mturk-requester-2017-01-17/RejectQualificationRequest AWS API Documentation
|
2246
|
+
#
|
2247
|
+
# @overload reject_qualification_request(params = {})
|
2248
|
+
# @param [Hash] params ({})
|
2249
|
+
def reject_qualification_request(params = {}, options = {})
|
2250
|
+
req = build_request(:reject_qualification_request, params)
|
2251
|
+
req.send_request(options)
|
2252
|
+
end
|
2253
|
+
|
2254
|
+
# The `SendBonus` operation issues a payment of money from your account
|
2255
|
+
# to a Worker. This payment happens separately from the reward you pay
|
2256
|
+
# to the Worker when you approve the Worker's assignment. The SendBonus
|
2257
|
+
# operation requires the Worker's ID and the assignment ID as
|
2258
|
+
# parameters to initiate payment of the bonus. You must include a
|
2259
|
+
# message that explains the reason for the bonus payment, as the Worker
|
2260
|
+
# may not be expecting the payment. Amazon Mechanical Turk collects a
|
2261
|
+
# fee for bonus payments, similar to the HIT listing fee. This operation
|
2262
|
+
# fails if your account does not have enough funds to pay for both the
|
2263
|
+
# bonus and the fees.
|
2264
|
+
#
|
2265
|
+
# @option params [required, String] :worker_id
|
2266
|
+
# The ID of the Worker being paid the bonus.
|
2267
|
+
#
|
2268
|
+
# @option params [required, String] :bonus_amount
|
2269
|
+
# The Bonus amount is a US Dollar amount specified using a string (for
|
2270
|
+
# example, "5" represents $5.00 USD and "101.42" represents $101.42
|
2271
|
+
# USD). Do not include currency symbols or currency codes.
|
2272
|
+
#
|
2273
|
+
# @option params [required, String] :assignment_id
|
2274
|
+
# The ID of the assignment for which this bonus is paid.
|
2275
|
+
#
|
2276
|
+
# @option params [String] :reason
|
2277
|
+
# A message that explains the reason for the bonus payment. The Worker
|
2278
|
+
# receiving the bonus can see this message.
|
2279
|
+
#
|
2280
|
+
# @option params [String] :unique_request_token
|
2281
|
+
# A unique identifier for this request, which allows you to retry the
|
2282
|
+
# call on error without granting multiple bonuses. This is useful in
|
2283
|
+
# cases such as network timeouts where it is unclear whether or not the
|
2284
|
+
# call succeeded on the server. If the bonus already exists in the
|
2285
|
+
# system from a previous call using the same UniqueRequestToken,
|
2286
|
+
# subsequent calls will return an error with a message containing the
|
2287
|
+
# request ID.
|
2288
|
+
#
|
2289
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2290
|
+
#
|
2291
|
+
# @example Request syntax with placeholder values
|
2292
|
+
#
|
2293
|
+
# resp = client.send_bonus({
|
2294
|
+
# worker_id: "CustomerId", # required
|
2295
|
+
# bonus_amount: "NumericValue", # required
|
2296
|
+
# assignment_id: "EntityId", # required
|
2297
|
+
# reason: "String",
|
2298
|
+
# unique_request_token: "IdempotencyToken",
|
2299
|
+
# })
|
2300
|
+
#
|
2301
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mturk-requester-2017-01-17/SendBonus AWS API Documentation
|
2302
|
+
#
|
2303
|
+
# @overload send_bonus(params = {})
|
2304
|
+
# @param [Hash] params ({})
|
2305
|
+
def send_bonus(params = {}, options = {})
|
2306
|
+
req = build_request(:send_bonus, params)
|
2307
|
+
req.send_request(options)
|
2308
|
+
end
|
2309
|
+
|
2310
|
+
# The `SendTestEventNotification` operation causes Amazon Mechanical
|
2311
|
+
# Turk to send a notification message as if a HIT event occurred,
|
2312
|
+
# according to the provided notification specification. This allows you
|
2313
|
+
# to test notifications without setting up notifications for a real HIT
|
2314
|
+
# type and trying to trigger them using the website. When you call this
|
2315
|
+
# operation, the service attempts to send the test notification
|
2316
|
+
# immediately.
|
2317
|
+
#
|
2318
|
+
# @option params [required, Types::NotificationSpecification] :notification
|
2319
|
+
# The notification specification to test. This value is identical to the
|
2320
|
+
# value you would provide to the UpdateNotificationSettings operation
|
2321
|
+
# when you establish the notification specification for a HIT type.
|
2322
|
+
#
|
2323
|
+
# @option params [required, String] :test_event_type
|
2324
|
+
# The event to simulate to test the notification specification. This
|
2325
|
+
# event is included in the test message even if the notification
|
2326
|
+
# specification does not include the event type. The notification
|
2327
|
+
# specification does not filter out the test event.
|
2328
|
+
#
|
2329
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2330
|
+
#
|
2331
|
+
# @example Request syntax with placeholder values
|
2332
|
+
#
|
2333
|
+
# resp = client.send_test_event_notification({
|
2334
|
+
# notification: { # required
|
2335
|
+
# destination: "String", # required
|
2336
|
+
# transport: "Email", # required, accepts Email, SQS
|
2337
|
+
# version: "String",
|
2338
|
+
# event_types: ["AssignmentAccepted"], # accepts AssignmentAccepted, AssignmentAbandoned, AssignmentReturned, AssignmentSubmitted, AssignmentRejected, AssignmentApproved, HITCreated, HITExpired, HITReviewable, HITExtended, HITDisposed, Ping
|
2339
|
+
# },
|
2340
|
+
# test_event_type: "AssignmentAccepted", # required, accepts AssignmentAccepted, AssignmentAbandoned, AssignmentReturned, AssignmentSubmitted, AssignmentRejected, AssignmentApproved, HITCreated, HITExpired, HITReviewable, HITExtended, HITDisposed, Ping
|
2341
|
+
# })
|
2342
|
+
#
|
2343
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mturk-requester-2017-01-17/SendTestEventNotification AWS API Documentation
|
2344
|
+
#
|
2345
|
+
# @overload send_test_event_notification(params = {})
|
2346
|
+
# @param [Hash] params ({})
|
2347
|
+
def send_test_event_notification(params = {}, options = {})
|
2348
|
+
req = build_request(:send_test_event_notification, params)
|
2349
|
+
req.send_request(options)
|
2350
|
+
end
|
2351
|
+
|
2352
|
+
# The `UpdateExpirationForHIT` operation allows you update the
|
2353
|
+
# expiration time of a HIT. If you update it to a time in the past, the
|
2354
|
+
# HIT will be immediately expired.
|
2355
|
+
#
|
2356
|
+
# @option params [required, String] :hit_id
|
2357
|
+
# The HIT to update.
|
2358
|
+
#
|
2359
|
+
# @option params [Time,DateTime,Date,Integer,String] :expire_at
|
2360
|
+
# The date and time at which you want the HIT to expire
|
2361
|
+
#
|
2362
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2363
|
+
#
|
2364
|
+
# @example Request syntax with placeholder values
|
2365
|
+
#
|
2366
|
+
# resp = client.update_expiration_for_hit({
|
2367
|
+
# hit_id: "EntityId", # required
|
2368
|
+
# expire_at: Time.now,
|
2369
|
+
# })
|
2370
|
+
#
|
2371
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mturk-requester-2017-01-17/UpdateExpirationForHIT AWS API Documentation
|
2372
|
+
#
|
2373
|
+
# @overload update_expiration_for_hit(params = {})
|
2374
|
+
# @param [Hash] params ({})
|
2375
|
+
def update_expiration_for_hit(params = {}, options = {})
|
2376
|
+
req = build_request(:update_expiration_for_hit, params)
|
2377
|
+
req.send_request(options)
|
2378
|
+
end
|
2379
|
+
|
2380
|
+
# The `UpdateHITReviewStatus` operation updates the status of a HIT. If
|
2381
|
+
# the status is Reviewable, this operation can update the status to
|
2382
|
+
# Reviewing, or it can revert a Reviewing HIT back to the Reviewable
|
2383
|
+
# status.
|
2384
|
+
#
|
2385
|
+
# @option params [required, String] :hit_id
|
2386
|
+
# The ID of the HIT to update.
|
2387
|
+
#
|
2388
|
+
# @option params [Boolean] :revert
|
2389
|
+
# Specifies how to update the HIT status. Default is `False`.
|
2390
|
+
#
|
2391
|
+
# * Setting this to false will only transition a HIT from `Reviewable`
|
2392
|
+
# to `Reviewing`
|
2393
|
+
#
|
2394
|
+
# * Setting this to true will only transition a HIT from `Reviewing` to
|
2395
|
+
# `Reviewable`
|
2396
|
+
#
|
2397
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2398
|
+
#
|
2399
|
+
# @example Request syntax with placeholder values
|
2400
|
+
#
|
2401
|
+
# resp = client.update_hit_review_status({
|
2402
|
+
# hit_id: "EntityId", # required
|
2403
|
+
# revert: false,
|
2404
|
+
# })
|
2405
|
+
#
|
2406
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mturk-requester-2017-01-17/UpdateHITReviewStatus AWS API Documentation
|
2407
|
+
#
|
2408
|
+
# @overload update_hit_review_status(params = {})
|
2409
|
+
# @param [Hash] params ({})
|
2410
|
+
def update_hit_review_status(params = {}, options = {})
|
2411
|
+
req = build_request(:update_hit_review_status, params)
|
2412
|
+
req.send_request(options)
|
2413
|
+
end
|
2414
|
+
|
2415
|
+
# The `UpdateHITTypeOfHIT` operation allows you to change the HITType
|
2416
|
+
# properties of a HIT. This operation disassociates the HIT from its old
|
2417
|
+
# HITType properties and associates it with the new HITType properties.
|
2418
|
+
# The HIT takes on the properties of the new HITType in place of the old
|
2419
|
+
# ones.
|
2420
|
+
#
|
2421
|
+
# @option params [required, String] :hit_id
|
2422
|
+
# The HIT to update.
|
2423
|
+
#
|
2424
|
+
# @option params [required, String] :hit_type_id
|
2425
|
+
# The ID of the new HIT type.
|
2426
|
+
#
|
2427
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2428
|
+
#
|
2429
|
+
# @example Request syntax with placeholder values
|
2430
|
+
#
|
2431
|
+
# resp = client.update_hit_type_of_hit({
|
2432
|
+
# hit_id: "EntityId", # required
|
2433
|
+
# hit_type_id: "EntityId", # required
|
2434
|
+
# })
|
2435
|
+
#
|
2436
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mturk-requester-2017-01-17/UpdateHITTypeOfHIT AWS API Documentation
|
2437
|
+
#
|
2438
|
+
# @overload update_hit_type_of_hit(params = {})
|
2439
|
+
# @param [Hash] params ({})
|
2440
|
+
def update_hit_type_of_hit(params = {}, options = {})
|
2441
|
+
req = build_request(:update_hit_type_of_hit, params)
|
2442
|
+
req.send_request(options)
|
2443
|
+
end
|
2444
|
+
|
2445
|
+
# The `UpdateNotificationSettings` operation creates, updates, disables
|
2446
|
+
# or re-enables notifications for a HIT type. If you call the
|
2447
|
+
# UpdateNotificationSettings operation for a HIT type that already has a
|
2448
|
+
# notification specification, the operation replaces the old
|
2449
|
+
# specification with a new one. You can call the
|
2450
|
+
# UpdateNotificationSettings operation to enable or disable
|
2451
|
+
# notifications for the HIT type, without having to modify the
|
2452
|
+
# notification specification itself by providing updates to the Active
|
2453
|
+
# status without specifying a new notification specification. To change
|
2454
|
+
# the Active status of a HIT type's notifications, the HIT type must
|
2455
|
+
# already have a notification specification, or one must be provided in
|
2456
|
+
# the same call to `UpdateNotificationSettings`.
|
2457
|
+
#
|
2458
|
+
# @option params [required, String] :hit_type_id
|
2459
|
+
# The ID of the HIT type whose notification specification is being
|
2460
|
+
# updated.
|
2461
|
+
#
|
2462
|
+
# @option params [Types::NotificationSpecification] :notification
|
2463
|
+
# The notification specification for the HIT type.
|
2464
|
+
#
|
2465
|
+
# @option params [Boolean] :active
|
2466
|
+
# Specifies whether notifications are sent for HITs of this HIT type,
|
2467
|
+
# according to the notification specification. You must specify either
|
2468
|
+
# the Notification parameter or the Active parameter for the call to
|
2469
|
+
# UpdateNotificationSettings to succeed.
|
2470
|
+
#
|
2471
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2472
|
+
#
|
2473
|
+
# @example Request syntax with placeholder values
|
2474
|
+
#
|
2475
|
+
# resp = client.update_notification_settings({
|
2476
|
+
# hit_type_id: "EntityId", # required
|
2477
|
+
# notification: {
|
2478
|
+
# destination: "String", # required
|
2479
|
+
# transport: "Email", # required, accepts Email, SQS
|
2480
|
+
# version: "String",
|
2481
|
+
# event_types: ["AssignmentAccepted"], # accepts AssignmentAccepted, AssignmentAbandoned, AssignmentReturned, AssignmentSubmitted, AssignmentRejected, AssignmentApproved, HITCreated, HITExpired, HITReviewable, HITExtended, HITDisposed, Ping
|
2482
|
+
# },
|
2483
|
+
# active: false,
|
2484
|
+
# })
|
2485
|
+
#
|
2486
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mturk-requester-2017-01-17/UpdateNotificationSettings AWS API Documentation
|
2487
|
+
#
|
2488
|
+
# @overload update_notification_settings(params = {})
|
2489
|
+
# @param [Hash] params ({})
|
2490
|
+
def update_notification_settings(params = {}, options = {})
|
2491
|
+
req = build_request(:update_notification_settings, params)
|
2492
|
+
req.send_request(options)
|
2493
|
+
end
|
2494
|
+
|
2495
|
+
# The `UpdateQualificationType` operation modifies the attributes of an
|
2496
|
+
# existing Qualification type, which is represented by a
|
2497
|
+
# QualificationType data structure. Only the owner of a Qualification
|
2498
|
+
# type can modify its attributes.
|
2499
|
+
#
|
2500
|
+
# Most attributes of a Qualification type can be changed after the type
|
2501
|
+
# has been created. However, the Name and Keywords fields cannot be
|
2502
|
+
# modified. The RetryDelayInSeconds parameter can be modified or added
|
2503
|
+
# to change the delay or to enable retries, but RetryDelayInSeconds
|
2504
|
+
# cannot be used to disable retries.
|
2505
|
+
#
|
2506
|
+
# You can use this operation to update the test for a Qualification
|
2507
|
+
# type. The test is updated based on the values specified for the Test,
|
2508
|
+
# TestDurationInSeconds and AnswerKey parameters. All three parameters
|
2509
|
+
# specify the updated test. If you are updating the test for a type, you
|
2510
|
+
# must specify the Test and TestDurationInSeconds parameters. The
|
2511
|
+
# AnswerKey parameter is optional; omitting it specifies that the
|
2512
|
+
# updated test does not have an answer key.
|
2513
|
+
#
|
2514
|
+
# If you omit the Test parameter, the test for the Qualification type is
|
2515
|
+
# unchanged. There is no way to remove a test from a Qualification type
|
2516
|
+
# that has one. If the type already has a test, you cannot update it to
|
2517
|
+
# be AutoGranted. If the Qualification type does not have a test and one
|
2518
|
+
# is provided by an update, the type will henceforth have a test.
|
2519
|
+
#
|
2520
|
+
# If you want to update the test duration or answer key for an existing
|
2521
|
+
# test without changing the questions, you must specify a Test parameter
|
2522
|
+
# with the original questions, along with the updated values.
|
2523
|
+
#
|
2524
|
+
# If you provide an updated Test but no AnswerKey, the new test will not
|
2525
|
+
# have an answer key. Requests for such Qualifications must be granted
|
2526
|
+
# manually.
|
2527
|
+
#
|
2528
|
+
# You can also update the AutoGranted and AutoGrantedValue attributes of
|
2529
|
+
# the Qualification type.
|
2530
|
+
#
|
2531
|
+
# @option params [required, String] :qualification_type_id
|
2532
|
+
# The ID of the Qualification type to update.
|
2533
|
+
#
|
2534
|
+
# @option params [String] :description
|
2535
|
+
# The new description of the Qualification type.
|
2536
|
+
#
|
2537
|
+
# @option params [String] :qualification_type_status
|
2538
|
+
# The new status of the Qualification type - Active \| Inactive
|
2539
|
+
#
|
2540
|
+
# @option params [String] :test
|
2541
|
+
# The questions for the Qualification test a Worker must answer
|
2542
|
+
# correctly to obtain a Qualification of this type. If this parameter is
|
2543
|
+
# specified, `TestDurationInSeconds` must also be specified.
|
2544
|
+
#
|
2545
|
+
# Constraints: Must not be longer than 65535 bytes. Must be a
|
2546
|
+
# QuestionForm data structure. This parameter cannot be specified if
|
2547
|
+
# AutoGranted is true.
|
2548
|
+
#
|
2549
|
+
# Constraints: None. If not specified, the Worker may request the
|
2550
|
+
# Qualification without answering any questions.
|
2551
|
+
#
|
2552
|
+
# @option params [String] :answer_key
|
2553
|
+
# The answers to the Qualification test specified in the Test parameter,
|
2554
|
+
# in the form of an AnswerKey data structure.
|
2555
|
+
#
|
2556
|
+
# @option params [Integer] :test_duration_in_seconds
|
2557
|
+
# The number of seconds the Worker has to complete the Qualification
|
2558
|
+
# test, starting from the time the Worker requests the Qualification.
|
2559
|
+
#
|
2560
|
+
# @option params [Integer] :retry_delay_in_seconds
|
2561
|
+
# The amount of time, in seconds, that Workers must wait after
|
2562
|
+
# requesting a Qualification of the specified Qualification type before
|
2563
|
+
# they can retry the Qualification request. It is not possible to
|
2564
|
+
# disable retries for a Qualification type after it has been created
|
2565
|
+
# with retries enabled. If you want to disable retries, you must dispose
|
2566
|
+
# of the existing retry-enabled Qualification type using
|
2567
|
+
# DisposeQualificationType and then create a new Qualification type with
|
2568
|
+
# retries disabled using CreateQualificationType.
|
2569
|
+
#
|
2570
|
+
# @option params [Boolean] :auto_granted
|
2571
|
+
# Specifies whether requests for the Qualification type are granted
|
2572
|
+
# immediately, without prompting the Worker with a Qualification test.
|
2573
|
+
#
|
2574
|
+
# Constraints: If the Test parameter is specified, this parameter cannot
|
2575
|
+
# be true.
|
2576
|
+
#
|
2577
|
+
# @option params [Integer] :auto_granted_value
|
2578
|
+
# The Qualification value to use for automatically granted
|
2579
|
+
# Qualifications. This parameter is used only if the AutoGranted
|
2580
|
+
# parameter is true.
|
2581
|
+
#
|
2582
|
+
# @return [Types::UpdateQualificationTypeResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2583
|
+
#
|
2584
|
+
# * {Types::UpdateQualificationTypeResponse#qualification_type #qualification_type} => Types::QualificationType
|
2585
|
+
#
|
2586
|
+
# @example Request syntax with placeholder values
|
2587
|
+
#
|
2588
|
+
# resp = client.update_qualification_type({
|
2589
|
+
# qualification_type_id: "EntityId", # required
|
2590
|
+
# description: "String",
|
2591
|
+
# qualification_type_status: "Active", # accepts Active, Inactive
|
2592
|
+
# test: "String",
|
2593
|
+
# answer_key: "String",
|
2594
|
+
# test_duration_in_seconds: 1,
|
2595
|
+
# retry_delay_in_seconds: 1,
|
2596
|
+
# auto_granted: false,
|
2597
|
+
# auto_granted_value: 1,
|
2598
|
+
# })
|
2599
|
+
#
|
2600
|
+
# @example Response structure
|
2601
|
+
#
|
2602
|
+
# resp.qualification_type.qualification_type_id #=> String
|
2603
|
+
# resp.qualification_type.creation_time #=> Time
|
2604
|
+
# resp.qualification_type.name #=> String
|
2605
|
+
# resp.qualification_type.description #=> String
|
2606
|
+
# resp.qualification_type.keywords #=> String
|
2607
|
+
# resp.qualification_type.qualification_type_status #=> String, one of "Active", "Inactive"
|
2608
|
+
# resp.qualification_type.test #=> String
|
2609
|
+
# resp.qualification_type.test_duration_in_seconds #=> Integer
|
2610
|
+
# resp.qualification_type.answer_key #=> String
|
2611
|
+
# resp.qualification_type.retry_delay_in_seconds #=> Integer
|
2612
|
+
# resp.qualification_type.is_requestable #=> Boolean
|
2613
|
+
# resp.qualification_type.auto_granted #=> Boolean
|
2614
|
+
# resp.qualification_type.auto_granted_value #=> Integer
|
2615
|
+
#
|
2616
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mturk-requester-2017-01-17/UpdateQualificationType AWS API Documentation
|
2617
|
+
#
|
2618
|
+
# @overload update_qualification_type(params = {})
|
2619
|
+
# @param [Hash] params ({})
|
2620
|
+
def update_qualification_type(params = {}, options = {})
|
2621
|
+
req = build_request(:update_qualification_type, params)
|
2622
|
+
req.send_request(options)
|
2623
|
+
end
|
2624
|
+
|
2625
|
+
# @!endgroup
|
2626
|
+
|
2627
|
+
# @param params ({})
|
2628
|
+
# @api private
|
2629
|
+
def build_request(operation_name, params = {})
|
2630
|
+
handlers = @handlers.for(operation_name)
|
2631
|
+
context = Seahorse::Client::RequestContext.new(
|
2632
|
+
operation_name: operation_name,
|
2633
|
+
operation: config.api.operation(operation_name),
|
2634
|
+
client: self,
|
2635
|
+
params: params,
|
2636
|
+
config: config)
|
2637
|
+
context[:gem_name] = 'aws-sdk-mturk'
|
2638
|
+
context[:gem_version] = '1.0.0.rc1'
|
2639
|
+
Seahorse::Client::Request.new(handlers, context)
|
2640
|
+
end
|
2641
|
+
|
2642
|
+
# @api private
|
2643
|
+
# @deprecated
|
2644
|
+
def waiter_names
|
2645
|
+
[]
|
2646
|
+
end
|
2647
|
+
|
2648
|
+
class << self
|
2649
|
+
|
2650
|
+
# @api private
|
2651
|
+
attr_reader :identifier
|
2652
|
+
|
2653
|
+
# @api private
|
2654
|
+
def errors_module
|
2655
|
+
Errors
|
2656
|
+
end
|
2657
|
+
|
2658
|
+
end
|
2659
|
+
end
|
2660
|
+
end
|