Skip to content

MTurkClient

Index > MTurk > MTurkClient

Auto-generated documentation for MTurk type annotations stubs module mypy-boto3-mturk.

MTurkClient

Type annotations and code completion for boto3.client("mturk"). boto3 documentation

Usage example
from boto3.session import Session
from mypy_boto3_mturk.client import MTurkClient

def get_mturk_client() -> MTurkClient:
    return Session().client("mturk")

Exceptions

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("mturk").exceptions structure.

Usage example
client = boto3.client("mturk")

try:
    do_something(client)
except (
    client.ClientError,
    client.RequestError,
    client.ServiceFault,
) as e:
    print(e)
Type checking example
from mypy_boto3_mturk.client import Exceptions

def handle_error(exc: Exceptions.ClientError) -> None:
    ...

Methods

accept_qualification_request

The AcceptQualificationRequest operation approves a Worker's request for a Qualification.

Type annotations and code completion for boto3.client("mturk").accept_qualification_request method. boto3 documentation

Method definition
def accept_qualification_request(
    self,
    *,
    QualificationRequestId: str,
    IntegerValue: int = ...,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: AcceptQualificationRequestRequestRequestTypeDef = {  # (1)
    "QualificationRequestId": ...,
}

parent.accept_qualification_request(**kwargs)
  1. See AcceptQualificationRequestRequestRequestTypeDef

approve_assignment

The ApproveAssignment operation approves the results of a completed assignment.

Type annotations and code completion for boto3.client("mturk").approve_assignment method. boto3 documentation

Method definition
def approve_assignment(
    self,
    *,
    AssignmentId: str,
    RequesterFeedback: str = ...,
    OverrideRejection: bool = ...,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: ApproveAssignmentRequestRequestTypeDef = {  # (1)
    "AssignmentId": ...,
}

parent.approve_assignment(**kwargs)
  1. See ApproveAssignmentRequestRequestTypeDef

associate_qualification_with_worker

The AssociateQualificationWithWorker operation gives a Worker a Qualification.

Type annotations and code completion for boto3.client("mturk").associate_qualification_with_worker method. boto3 documentation

Method definition
def associate_qualification_with_worker(
    self,
    *,
    QualificationTypeId: str,
    WorkerId: str,
    IntegerValue: int = ...,
    SendNotification: bool = ...,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: AssociateQualificationWithWorkerRequestRequestTypeDef = {  # (1)
    "QualificationTypeId": ...,
    "WorkerId": ...,
}

parent.associate_qualification_with_worker(**kwargs)
  1. See AssociateQualificationWithWorkerRequestRequestTypeDef

can_paginate

Check if an operation can be paginated.

Type annotations and code completion for boto3.client("mturk").can_paginate method. boto3 documentation

Method definition
def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

close

Closes underlying endpoint connections.

Type annotations and code completion for boto3.client("mturk").close method. boto3 documentation

Method definition
def close(
    self,
) -> None:
    ...

create_additional_assignments_for_hit

The CreateAdditionalAssignmentsForHIT operation increases the maximum number of assignments of an existing HIT.

Type annotations and code completion for boto3.client("mturk").create_additional_assignments_for_hit method. boto3 documentation

Method definition
def create_additional_assignments_for_hit(
    self,
    *,
    HITId: str,
    NumberOfAdditionalAssignments: int,
    UniqueRequestToken: str = ...,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: CreateAdditionalAssignmentsForHITRequestRequestTypeDef = {  # (1)
    "HITId": ...,
    "NumberOfAdditionalAssignments": ...,
}

parent.create_additional_assignments_for_hit(**kwargs)
  1. See CreateAdditionalAssignmentsForHITRequestRequestTypeDef

create_hit

The CreateHIT operation creates a new Human Intelligence Task (HIT).

Type annotations and code completion for boto3.client("mturk").create_hit method. boto3 documentation

Method definition
def create_hit(
    self,
    *,
    LifetimeInSeconds: int,
    AssignmentDurationInSeconds: int,
    Reward: str,
    Title: str,
    Description: str,
    MaxAssignments: int = ...,
    AutoApprovalDelayInSeconds: int = ...,
    Keywords: str = ...,
    Question: str = ...,
    RequesterAnnotation: str = ...,
    QualificationRequirements: Sequence[QualificationRequirementTypeDef] = ...,  # (1)
    UniqueRequestToken: str = ...,
    AssignmentReviewPolicy: ReviewPolicyTypeDef = ...,  # (2)
    HITReviewPolicy: ReviewPolicyTypeDef = ...,  # (2)
    HITLayoutId: str = ...,
    HITLayoutParameters: Sequence[HITLayoutParameterTypeDef] = ...,  # (4)
) -> CreateHITResponseTypeDef:  # (5)
    ...
  1. See QualificationRequirementTypeDef
  2. See ReviewPolicyTypeDef
  3. See ReviewPolicyTypeDef
  4. See HITLayoutParameterTypeDef
  5. See CreateHITResponseTypeDef
Usage example with kwargs
kwargs: CreateHITRequestRequestTypeDef = {  # (1)
    "LifetimeInSeconds": ...,
    "AssignmentDurationInSeconds": ...,
    "Reward": ...,
    "Title": ...,
    "Description": ...,
}

parent.create_hit(**kwargs)
  1. See CreateHITRequestRequestTypeDef

create_hit_type

The CreateHITType operation creates a new HIT type.

Type annotations and code completion for boto3.client("mturk").create_hit_type method. boto3 documentation

Method definition
def create_hit_type(
    self,
    *,
    AssignmentDurationInSeconds: int,
    Reward: str,
    Title: str,
    Description: str,
    AutoApprovalDelayInSeconds: int = ...,
    Keywords: str = ...,
    QualificationRequirements: Sequence[QualificationRequirementTypeDef] = ...,  # (1)
) -> CreateHITTypeResponseTypeDef:  # (2)
    ...
  1. See QualificationRequirementTypeDef
  2. See CreateHITTypeResponseTypeDef
Usage example with kwargs
kwargs: CreateHITTypeRequestRequestTypeDef = {  # (1)
    "AssignmentDurationInSeconds": ...,
    "Reward": ...,
    "Title": ...,
    "Description": ...,
}

parent.create_hit_type(**kwargs)
  1. See CreateHITTypeRequestRequestTypeDef

create_hit_with_hit_type

The CreateHITWithHITType operation creates a new Human Intelligence Task (HIT) using an existing HITTypeID generated by the CreateHITType operation.

Type annotations and code completion for boto3.client("mturk").create_hit_with_hit_type method. boto3 documentation

Method definition
def create_hit_with_hit_type(
    self,
    *,
    HITTypeId: str,
    LifetimeInSeconds: int,
    MaxAssignments: int = ...,
    Question: str = ...,
    RequesterAnnotation: str = ...,
    UniqueRequestToken: str = ...,
    AssignmentReviewPolicy: ReviewPolicyTypeDef = ...,  # (1)
    HITReviewPolicy: ReviewPolicyTypeDef = ...,  # (1)
    HITLayoutId: str = ...,
    HITLayoutParameters: Sequence[HITLayoutParameterTypeDef] = ...,  # (3)
) -> CreateHITWithHITTypeResponseTypeDef:  # (4)
    ...
  1. See ReviewPolicyTypeDef
  2. See ReviewPolicyTypeDef
  3. See HITLayoutParameterTypeDef
  4. See CreateHITWithHITTypeResponseTypeDef
Usage example with kwargs
kwargs: CreateHITWithHITTypeRequestRequestTypeDef = {  # (1)
    "HITTypeId": ...,
    "LifetimeInSeconds": ...,
}

parent.create_hit_with_hit_type(**kwargs)
  1. See CreateHITWithHITTypeRequestRequestTypeDef

create_qualification_type

The CreateQualificationType operation creates a new Qualification type, which is represented by a QualificationType data structure.

Type annotations and code completion for boto3.client("mturk").create_qualification_type method. boto3 documentation

Method definition
def create_qualification_type(
    self,
    *,
    Name: str,
    Description: str,
    QualificationTypeStatus: QualificationTypeStatusType,  # (1)
    Keywords: str = ...,
    RetryDelayInSeconds: int = ...,
    Test: str = ...,
    AnswerKey: str = ...,
    TestDurationInSeconds: int = ...,
    AutoGranted: bool = ...,
    AutoGrantedValue: int = ...,
) -> CreateQualificationTypeResponseTypeDef:  # (2)
    ...
  1. See QualificationTypeStatusType
  2. See CreateQualificationTypeResponseTypeDef
Usage example with kwargs
kwargs: CreateQualificationTypeRequestRequestTypeDef = {  # (1)
    "Name": ...,
    "Description": ...,
    "QualificationTypeStatus": ...,
}

parent.create_qualification_type(**kwargs)
  1. See CreateQualificationTypeRequestRequestTypeDef

create_worker_block

The CreateWorkerBlock operation allows you to prevent a Worker from working on your HITs.

Type annotations and code completion for boto3.client("mturk").create_worker_block method. boto3 documentation

Method definition
def create_worker_block(
    self,
    *,
    WorkerId: str,
    Reason: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: CreateWorkerBlockRequestRequestTypeDef = {  # (1)
    "WorkerId": ...,
    "Reason": ...,
}

parent.create_worker_block(**kwargs)
  1. See CreateWorkerBlockRequestRequestTypeDef

delete_hit

The DeleteHIT operation is used to delete HIT that is no longer needed.

Type annotations and code completion for boto3.client("mturk").delete_hit method. boto3 documentation

Method definition
def delete_hit(
    self,
    *,
    HITId: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: DeleteHITRequestRequestTypeDef = {  # (1)
    "HITId": ...,
}

parent.delete_hit(**kwargs)
  1. See DeleteHITRequestRequestTypeDef

delete_qualification_type

The DeleteQualificationType deletes a Qualification type and deletes any HIT types that are associated with the Qualification type.

Type annotations and code completion for boto3.client("mturk").delete_qualification_type method. boto3 documentation

Method definition
def delete_qualification_type(
    self,
    *,
    QualificationTypeId: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: DeleteQualificationTypeRequestRequestTypeDef = {  # (1)
    "QualificationTypeId": ...,
}

parent.delete_qualification_type(**kwargs)
  1. See DeleteQualificationTypeRequestRequestTypeDef

delete_worker_block

The DeleteWorkerBlock operation allows you to reinstate a blocked Worker to work on your HITs.

Type annotations and code completion for boto3.client("mturk").delete_worker_block method. boto3 documentation

Method definition
def delete_worker_block(
    self,
    *,
    WorkerId: str,
    Reason: str = ...,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: DeleteWorkerBlockRequestRequestTypeDef = {  # (1)
    "WorkerId": ...,
}

parent.delete_worker_block(**kwargs)
  1. See DeleteWorkerBlockRequestRequestTypeDef

disassociate_qualification_from_worker

The DisassociateQualificationFromWorker revokes a previously granted Qualification from a user.

Type annotations and code completion for boto3.client("mturk").disassociate_qualification_from_worker method. boto3 documentation

Method definition
def disassociate_qualification_from_worker(
    self,
    *,
    WorkerId: str,
    QualificationTypeId: str,
    Reason: str = ...,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: DisassociateQualificationFromWorkerRequestRequestTypeDef = {  # (1)
    "WorkerId": ...,
    "QualificationTypeId": ...,
}

parent.disassociate_qualification_from_worker(**kwargs)
  1. See DisassociateQualificationFromWorkerRequestRequestTypeDef

generate_presigned_url

Generate a presigned url given a client, its method, and arguments.

Type annotations and code completion for boto3.client("mturk").generate_presigned_url method. boto3 documentation

Method definition
def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

get_account_balance

The GetAccountBalance operation retrieves the Prepaid HITs balance in your Amazon Mechanical Turk account if you are a Prepaid Requester.

Type annotations and code completion for boto3.client("mturk").get_account_balance method. boto3 documentation

Method definition
def get_account_balance(
    self,
) -> GetAccountBalanceResponseTypeDef:  # (1)
    ...
  1. See GetAccountBalanceResponseTypeDef

get_assignment

The GetAssignment operation retrieves the details of the specified Assignment.

Type annotations and code completion for boto3.client("mturk").get_assignment method. boto3 documentation

Method definition
def get_assignment(
    self,
    *,
    AssignmentId: str,
) -> GetAssignmentResponseTypeDef:  # (1)
    ...
  1. See GetAssignmentResponseTypeDef
Usage example with kwargs
kwargs: GetAssignmentRequestRequestTypeDef = {  # (1)
    "AssignmentId": ...,
}

parent.get_assignment(**kwargs)
  1. See GetAssignmentRequestRequestTypeDef

get_file_upload_url

The GetFileUploadURL operation generates and returns a temporary URL.

Type annotations and code completion for boto3.client("mturk").get_file_upload_url method. boto3 documentation

Method definition
def get_file_upload_url(
    self,
    *,
    AssignmentId: str,
    QuestionIdentifier: str,
) -> GetFileUploadURLResponseTypeDef:  # (1)
    ...
  1. See GetFileUploadURLResponseTypeDef
Usage example with kwargs
kwargs: GetFileUploadURLRequestRequestTypeDef = {  # (1)
    "AssignmentId": ...,
    "QuestionIdentifier": ...,
}

parent.get_file_upload_url(**kwargs)
  1. See GetFileUploadURLRequestRequestTypeDef

get_hit

The GetHIT operation retrieves the details of the specified HIT.

Type annotations and code completion for boto3.client("mturk").get_hit method. boto3 documentation

Method definition
def get_hit(
    self,
    *,
    HITId: str,
) -> GetHITResponseTypeDef:  # (1)
    ...
  1. See GetHITResponseTypeDef
Usage example with kwargs
kwargs: GetHITRequestRequestTypeDef = {  # (1)
    "HITId": ...,
}

parent.get_hit(**kwargs)
  1. See GetHITRequestRequestTypeDef

get_qualification_score

The GetQualificationScore operation returns the value of a Worker's Qualification for a given Qualification type.

Type annotations and code completion for boto3.client("mturk").get_qualification_score method. boto3 documentation

Method definition
def get_qualification_score(
    self,
    *,
    QualificationTypeId: str,
    WorkerId: str,
) -> GetQualificationScoreResponseTypeDef:  # (1)
    ...
  1. See GetQualificationScoreResponseTypeDef
Usage example with kwargs
kwargs: GetQualificationScoreRequestRequestTypeDef = {  # (1)
    "QualificationTypeId": ...,
    "WorkerId": ...,
}

parent.get_qualification_score(**kwargs)
  1. See GetQualificationScoreRequestRequestTypeDef

get_qualification_type

The GetQualificationType operation retrieves information about a Qualification type using its ID.

Type annotations and code completion for boto3.client("mturk").get_qualification_type method. boto3 documentation

Method definition
def get_qualification_type(
    self,
    *,
    QualificationTypeId: str,
) -> GetQualificationTypeResponseTypeDef:  # (1)
    ...
  1. See GetQualificationTypeResponseTypeDef
Usage example with kwargs
kwargs: GetQualificationTypeRequestRequestTypeDef = {  # (1)
    "QualificationTypeId": ...,
}

parent.get_qualification_type(**kwargs)
  1. See GetQualificationTypeRequestRequestTypeDef

list_assignments_for_hit

The ListAssignmentsForHIT operation retrieves completed assignments for a HIT.

Type annotations and code completion for boto3.client("mturk").list_assignments_for_hit method. boto3 documentation

Method definition
def list_assignments_for_hit(
    self,
    *,
    HITId: str,
    NextToken: str = ...,
    MaxResults: int = ...,
    AssignmentStatuses: Sequence[AssignmentStatusType] = ...,  # (1)
) -> ListAssignmentsForHITResponseTypeDef:  # (2)
    ...
  1. See AssignmentStatusType
  2. See ListAssignmentsForHITResponseTypeDef
Usage example with kwargs
kwargs: ListAssignmentsForHITRequestRequestTypeDef = {  # (1)
    "HITId": ...,
}

parent.list_assignments_for_hit(**kwargs)
  1. See ListAssignmentsForHITRequestRequestTypeDef

list_bonus_payments

The ListBonusPayments operation retrieves the amounts of bonuses you have paid to Workers for a given HIT or assignment.

Type annotations and code completion for boto3.client("mturk").list_bonus_payments method. boto3 documentation

Method definition
def list_bonus_payments(
    self,
    *,
    HITId: str = ...,
    AssignmentId: str = ...,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListBonusPaymentsResponseTypeDef:  # (1)
    ...
  1. See ListBonusPaymentsResponseTypeDef
Usage example with kwargs
kwargs: ListBonusPaymentsRequestRequestTypeDef = {  # (1)
    "HITId": ...,
}

parent.list_bonus_payments(**kwargs)
  1. See ListBonusPaymentsRequestRequestTypeDef

list_hits

The ListHITs operation returns all of a Requester's HITs.

Type annotations and code completion for boto3.client("mturk").list_hits method. boto3 documentation

Method definition
def list_hits(
    self,
    *,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListHITsResponseTypeDef:  # (1)
    ...
  1. See ListHITsResponseTypeDef
Usage example with kwargs
kwargs: ListHITsRequestRequestTypeDef = {  # (1)
    "NextToken": ...,
}

parent.list_hits(**kwargs)
  1. See ListHITsRequestRequestTypeDef

list_hits_for_qualification_type

The ListHITsForQualificationType operation returns the HITs that use the given Qualification type for a Qualification requirement.

Type annotations and code completion for boto3.client("mturk").list_hits_for_qualification_type method. boto3 documentation

Method definition
def list_hits_for_qualification_type(
    self,
    *,
    QualificationTypeId: str,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListHITsForQualificationTypeResponseTypeDef:  # (1)
    ...
  1. See ListHITsForQualificationTypeResponseTypeDef
Usage example with kwargs
kwargs: ListHITsForQualificationTypeRequestRequestTypeDef = {  # (1)
    "QualificationTypeId": ...,
}

parent.list_hits_for_qualification_type(**kwargs)
  1. See ListHITsForQualificationTypeRequestRequestTypeDef

list_qualification_requests

The ListQualificationRequests operation retrieves requests for Qualifications of a particular Qualification type.

Type annotations and code completion for boto3.client("mturk").list_qualification_requests method. boto3 documentation

Method definition
def list_qualification_requests(
    self,
    *,
    QualificationTypeId: str = ...,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListQualificationRequestsResponseTypeDef:  # (1)
    ...
  1. See ListQualificationRequestsResponseTypeDef
Usage example with kwargs
kwargs: ListQualificationRequestsRequestRequestTypeDef = {  # (1)
    "QualificationTypeId": ...,
}

parent.list_qualification_requests(**kwargs)
  1. See ListQualificationRequestsRequestRequestTypeDef

list_qualification_types

The ListQualificationTypes operation returns a list of Qualification types, filtered by an optional search term.

Type annotations and code completion for boto3.client("mturk").list_qualification_types method. boto3 documentation

Method definition
def list_qualification_types(
    self,
    *,
    MustBeRequestable: bool,
    Query: str = ...,
    MustBeOwnedByCaller: bool = ...,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListQualificationTypesResponseTypeDef:  # (1)
    ...
  1. See ListQualificationTypesResponseTypeDef
Usage example with kwargs
kwargs: ListQualificationTypesRequestRequestTypeDef = {  # (1)
    "MustBeRequestable": ...,
}

parent.list_qualification_types(**kwargs)
  1. See ListQualificationTypesRequestRequestTypeDef

list_review_policy_results_for_hit

The ListReviewPolicyResultsForHIT operation retrieves the computed results and the actions taken in the course of executing your Review Policies for a given HIT.

Type annotations and code completion for boto3.client("mturk").list_review_policy_results_for_hit method. boto3 documentation

Method definition
def list_review_policy_results_for_hit(
    self,
    *,
    HITId: str,
    PolicyLevels: Sequence[ReviewPolicyLevelType] = ...,  # (1)
    RetrieveActions: bool = ...,
    RetrieveResults: bool = ...,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListReviewPolicyResultsForHITResponseTypeDef:  # (2)
    ...
  1. See ReviewPolicyLevelType
  2. See ListReviewPolicyResultsForHITResponseTypeDef
Usage example with kwargs
kwargs: ListReviewPolicyResultsForHITRequestRequestTypeDef = {  # (1)
    "HITId": ...,
}

parent.list_review_policy_results_for_hit(**kwargs)
  1. See ListReviewPolicyResultsForHITRequestRequestTypeDef

list_reviewable_hits

The ListReviewableHITs operation retrieves the HITs with Status equal to Reviewable or Status equal to Reviewing that belong to the Requester calling the operation.

Type annotations and code completion for boto3.client("mturk").list_reviewable_hits method. boto3 documentation

Method definition
def list_reviewable_hits(
    self,
    *,
    HITTypeId: str = ...,
    Status: ReviewableHITStatusType = ...,  # (1)
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListReviewableHITsResponseTypeDef:  # (2)
    ...
  1. See ReviewableHITStatusType
  2. See ListReviewableHITsResponseTypeDef
Usage example with kwargs
kwargs: ListReviewableHITsRequestRequestTypeDef = {  # (1)
    "HITTypeId": ...,
}

parent.list_reviewable_hits(**kwargs)
  1. See ListReviewableHITsRequestRequestTypeDef

list_worker_blocks

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

Type annotations and code completion for boto3.client("mturk").list_worker_blocks method. boto3 documentation

Method definition
def list_worker_blocks(
    self,
    *,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListWorkerBlocksResponseTypeDef:  # (1)
    ...
  1. See ListWorkerBlocksResponseTypeDef
Usage example with kwargs
kwargs: ListWorkerBlocksRequestRequestTypeDef = {  # (1)
    "NextToken": ...,
}

parent.list_worker_blocks(**kwargs)
  1. See ListWorkerBlocksRequestRequestTypeDef

list_workers_with_qualification_type

The ListWorkersWithQualificationType operation returns all of the Workers that have been associated with a given Qualification type.

Type annotations and code completion for boto3.client("mturk").list_workers_with_qualification_type method. boto3 documentation

Method definition
def list_workers_with_qualification_type(
    self,
    *,
    QualificationTypeId: str,
    Status: QualificationStatusType = ...,  # (1)
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListWorkersWithQualificationTypeResponseTypeDef:  # (2)
    ...
  1. See QualificationStatusType
  2. See ListWorkersWithQualificationTypeResponseTypeDef
Usage example with kwargs
kwargs: ListWorkersWithQualificationTypeRequestRequestTypeDef = {  # (1)
    "QualificationTypeId": ...,
}

parent.list_workers_with_qualification_type(**kwargs)
  1. See ListWorkersWithQualificationTypeRequestRequestTypeDef

notify_workers

The NotifyWorkers operation sends an email to one or more Workers that you specify with the Worker ID.

Type annotations and code completion for boto3.client("mturk").notify_workers method. boto3 documentation

Method definition
def notify_workers(
    self,
    *,
    Subject: str,
    MessageText: str,
    WorkerIds: Sequence[str],
) -> NotifyWorkersResponseTypeDef:  # (1)
    ...
  1. See NotifyWorkersResponseTypeDef
Usage example with kwargs
kwargs: NotifyWorkersRequestRequestTypeDef = {  # (1)
    "Subject": ...,
    "MessageText": ...,
    "WorkerIds": ...,
}

parent.notify_workers(**kwargs)
  1. See NotifyWorkersRequestRequestTypeDef

reject_assignment

The RejectAssignment operation rejects the results of a completed assignment.

Type annotations and code completion for boto3.client("mturk").reject_assignment method. boto3 documentation

Method definition
def reject_assignment(
    self,
    *,
    AssignmentId: str,
    RequesterFeedback: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: RejectAssignmentRequestRequestTypeDef = {  # (1)
    "AssignmentId": ...,
    "RequesterFeedback": ...,
}

parent.reject_assignment(**kwargs)
  1. See RejectAssignmentRequestRequestTypeDef

reject_qualification_request

The RejectQualificationRequest operation rejects a user's request for a Qualification.

Type annotations and code completion for boto3.client("mturk").reject_qualification_request method. boto3 documentation

Method definition
def reject_qualification_request(
    self,
    *,
    QualificationRequestId: str,
    Reason: str = ...,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: RejectQualificationRequestRequestRequestTypeDef = {  # (1)
    "QualificationRequestId": ...,
}

parent.reject_qualification_request(**kwargs)
  1. See RejectQualificationRequestRequestRequestTypeDef

send_bonus

The SendBonus operation issues a payment of money from your account to a Worker.

Type annotations and code completion for boto3.client("mturk").send_bonus method. boto3 documentation

Method definition
def send_bonus(
    self,
    *,
    WorkerId: str,
    BonusAmount: str,
    AssignmentId: str,
    Reason: str,
    UniqueRequestToken: str = ...,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: SendBonusRequestRequestTypeDef = {  # (1)
    "WorkerId": ...,
    "BonusAmount": ...,
    "AssignmentId": ...,
    "Reason": ...,
}

parent.send_bonus(**kwargs)
  1. See SendBonusRequestRequestTypeDef

send_test_event_notification

The SendTestEventNotification operation causes Amazon Mechanical Turk to send a notification message as if a HIT event occurred, according to the provided notification specification.

Type annotations and code completion for boto3.client("mturk").send_test_event_notification method. boto3 documentation

Method definition
def send_test_event_notification(
    self,
    *,
    Notification: NotificationSpecificationTypeDef,  # (1)
    TestEventType: EventTypeType,  # (2)
) -> Dict[str, Any]:
    ...
  1. See NotificationSpecificationTypeDef
  2. See EventTypeType
Usage example with kwargs
kwargs: SendTestEventNotificationRequestRequestTypeDef = {  # (1)
    "Notification": ...,
    "TestEventType": ...,
}

parent.send_test_event_notification(**kwargs)
  1. See SendTestEventNotificationRequestRequestTypeDef

update_expiration_for_hit

The UpdateExpirationForHIT operation allows you update the expiration time of a HIT.

Type annotations and code completion for boto3.client("mturk").update_expiration_for_hit method. boto3 documentation

Method definition
def update_expiration_for_hit(
    self,
    *,
    HITId: str,
    ExpireAt: Union[datetime, str],
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: UpdateExpirationForHITRequestRequestTypeDef = {  # (1)
    "HITId": ...,
    "ExpireAt": ...,
}

parent.update_expiration_for_hit(**kwargs)
  1. See UpdateExpirationForHITRequestRequestTypeDef

update_hit_review_status

The UpdateHITReviewStatus operation updates the status of a HIT.

Type annotations and code completion for boto3.client("mturk").update_hit_review_status method. boto3 documentation

Method definition
def update_hit_review_status(
    self,
    *,
    HITId: str,
    Revert: bool = ...,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: UpdateHITReviewStatusRequestRequestTypeDef = {  # (1)
    "HITId": ...,
}

parent.update_hit_review_status(**kwargs)
  1. See UpdateHITReviewStatusRequestRequestTypeDef

update_hit_type_of_hit

The UpdateHITTypeOfHIT operation allows you to change the HITType properties of a HIT.

Type annotations and code completion for boto3.client("mturk").update_hit_type_of_hit method. boto3 documentation

Method definition
def update_hit_type_of_hit(
    self,
    *,
    HITId: str,
    HITTypeId: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: UpdateHITTypeOfHITRequestRequestTypeDef = {  # (1)
    "HITId": ...,
    "HITTypeId": ...,
}

parent.update_hit_type_of_hit(**kwargs)
  1. See UpdateHITTypeOfHITRequestRequestTypeDef

update_notification_settings

The UpdateNotificationSettings operation creates, updates, disables or re- enables notifications for a HIT type.

Type annotations and code completion for boto3.client("mturk").update_notification_settings method. boto3 documentation

Method definition
def update_notification_settings(
    self,
    *,
    HITTypeId: str,
    Notification: NotificationSpecificationTypeDef = ...,  # (1)
    Active: bool = ...,
) -> Dict[str, Any]:
    ...
  1. See NotificationSpecificationTypeDef
Usage example with kwargs
kwargs: UpdateNotificationSettingsRequestRequestTypeDef = {  # (1)
    "HITTypeId": ...,
}

parent.update_notification_settings(**kwargs)
  1. See UpdateNotificationSettingsRequestRequestTypeDef

update_qualification_type

The UpdateQualificationType operation modifies the attributes of an existing Qualification type, which is represented by a QualificationType data structure.

Type annotations and code completion for boto3.client("mturk").update_qualification_type method. boto3 documentation

Method definition
def update_qualification_type(
    self,
    *,
    QualificationTypeId: str,
    Description: str = ...,
    QualificationTypeStatus: QualificationTypeStatusType = ...,  # (1)
    Test: str = ...,
    AnswerKey: str = ...,
    TestDurationInSeconds: int = ...,
    RetryDelayInSeconds: int = ...,
    AutoGranted: bool = ...,
    AutoGrantedValue: int = ...,
) -> UpdateQualificationTypeResponseTypeDef:  # (2)
    ...
  1. See QualificationTypeStatusType
  2. See UpdateQualificationTypeResponseTypeDef
Usage example with kwargs
kwargs: UpdateQualificationTypeRequestRequestTypeDef = {  # (1)
    "QualificationTypeId": ...,
}

parent.update_qualification_type(**kwargs)
  1. See UpdateQualificationTypeRequestRequestTypeDef

get_paginator

Type annotations and code completion for boto3.client("mturk").get_paginator method with overloads.