Skip to content

Type definitions#

Index > MTurk > Type definitions

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

TimestampTypeDef#

# TimestampTypeDef definition

TimestampTypeDef = Union[
    datetime,
    str,
]

AcceptQualificationRequestRequestRequestTypeDef#

# AcceptQualificationRequestRequestRequestTypeDef definition

class AcceptQualificationRequestRequestRequestTypeDef(TypedDict):
    QualificationRequestId: str,
    IntegerValue: NotRequired[int],

ApproveAssignmentRequestRequestTypeDef#

# ApproveAssignmentRequestRequestTypeDef definition

class ApproveAssignmentRequestRequestTypeDef(TypedDict):
    AssignmentId: str,
    RequesterFeedback: NotRequired[str],
    OverrideRejection: NotRequired[bool],

AssignmentTypeDef#

# AssignmentTypeDef definition

class AssignmentTypeDef(TypedDict):
    AssignmentId: NotRequired[str],
    WorkerId: NotRequired[str],
    HITId: NotRequired[str],
    AssignmentStatus: NotRequired[AssignmentStatusType],  # (1)
    AutoApprovalTime: NotRequired[datetime],
    AcceptTime: NotRequired[datetime],
    SubmitTime: NotRequired[datetime],
    ApprovalTime: NotRequired[datetime],
    RejectionTime: NotRequired[datetime],
    Deadline: NotRequired[datetime],
    Answer: NotRequired[str],
    RequesterFeedback: NotRequired[str],
  1. See AssignmentStatusType

AssociateQualificationWithWorkerRequestRequestTypeDef#

# AssociateQualificationWithWorkerRequestRequestTypeDef definition

class AssociateQualificationWithWorkerRequestRequestTypeDef(TypedDict):
    QualificationTypeId: str,
    WorkerId: str,
    IntegerValue: NotRequired[int],
    SendNotification: NotRequired[bool],

BonusPaymentTypeDef#

# BonusPaymentTypeDef definition

class BonusPaymentTypeDef(TypedDict):
    WorkerId: NotRequired[str],
    BonusAmount: NotRequired[str],
    AssignmentId: NotRequired[str],
    Reason: NotRequired[str],
    GrantTime: NotRequired[datetime],

CreateAdditionalAssignmentsForHITRequestRequestTypeDef#

# CreateAdditionalAssignmentsForHITRequestRequestTypeDef definition

class CreateAdditionalAssignmentsForHITRequestRequestTypeDef(TypedDict):
    HITId: str,
    NumberOfAdditionalAssignments: int,
    UniqueRequestToken: NotRequired[str],

HITLayoutParameterTypeDef#

# HITLayoutParameterTypeDef definition

class HITLayoutParameterTypeDef(TypedDict):
    Name: str,
    Value: str,

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HTTPStatusCode: int,
    HTTPHeaders: Dict[str, str],
    RetryAttempts: int,
    HostId: NotRequired[str],

CreateQualificationTypeRequestRequestTypeDef#

# CreateQualificationTypeRequestRequestTypeDef definition

class CreateQualificationTypeRequestRequestTypeDef(TypedDict):
    Name: str,
    Description: str,
    QualificationTypeStatus: QualificationTypeStatusType,  # (1)
    Keywords: NotRequired[str],
    RetryDelayInSeconds: NotRequired[int],
    Test: NotRequired[str],
    AnswerKey: NotRequired[str],
    TestDurationInSeconds: NotRequired[int],
    AutoGranted: NotRequired[bool],
    AutoGrantedValue: NotRequired[int],
  1. See QualificationTypeStatusType

QualificationTypeTypeDef#

# QualificationTypeTypeDef definition

class QualificationTypeTypeDef(TypedDict):
    QualificationTypeId: NotRequired[str],
    CreationTime: NotRequired[datetime],
    Name: NotRequired[str],
    Description: NotRequired[str],
    Keywords: NotRequired[str],
    QualificationTypeStatus: NotRequired[QualificationTypeStatusType],  # (1)
    Test: NotRequired[str],
    TestDurationInSeconds: NotRequired[int],
    AnswerKey: NotRequired[str],
    RetryDelayInSeconds: NotRequired[int],
    IsRequestable: NotRequired[bool],
    AutoGranted: NotRequired[bool],
    AutoGrantedValue: NotRequired[int],
  1. See QualificationTypeStatusType

CreateWorkerBlockRequestRequestTypeDef#

# CreateWorkerBlockRequestRequestTypeDef definition

class CreateWorkerBlockRequestRequestTypeDef(TypedDict):
    WorkerId: str,
    Reason: str,

DeleteHITRequestRequestTypeDef#

# DeleteHITRequestRequestTypeDef definition

class DeleteHITRequestRequestTypeDef(TypedDict):
    HITId: str,

DeleteQualificationTypeRequestRequestTypeDef#

# DeleteQualificationTypeRequestRequestTypeDef definition

class DeleteQualificationTypeRequestRequestTypeDef(TypedDict):
    QualificationTypeId: str,

DeleteWorkerBlockRequestRequestTypeDef#

# DeleteWorkerBlockRequestRequestTypeDef definition

class DeleteWorkerBlockRequestRequestTypeDef(TypedDict):
    WorkerId: str,
    Reason: NotRequired[str],

DisassociateQualificationFromWorkerRequestRequestTypeDef#

# DisassociateQualificationFromWorkerRequestRequestTypeDef definition

class DisassociateQualificationFromWorkerRequestRequestTypeDef(TypedDict):
    WorkerId: str,
    QualificationTypeId: str,
    Reason: NotRequired[str],

GetAssignmentRequestRequestTypeDef#

# GetAssignmentRequestRequestTypeDef definition

class GetAssignmentRequestRequestTypeDef(TypedDict):
    AssignmentId: str,

GetFileUploadURLRequestRequestTypeDef#

# GetFileUploadURLRequestRequestTypeDef definition

class GetFileUploadURLRequestRequestTypeDef(TypedDict):
    AssignmentId: str,
    QuestionIdentifier: str,

GetHITRequestRequestTypeDef#

# GetHITRequestRequestTypeDef definition

class GetHITRequestRequestTypeDef(TypedDict):
    HITId: str,

GetQualificationScoreRequestRequestTypeDef#

# GetQualificationScoreRequestRequestTypeDef definition

class GetQualificationScoreRequestRequestTypeDef(TypedDict):
    QualificationTypeId: str,
    WorkerId: str,

GetQualificationTypeRequestRequestTypeDef#

# GetQualificationTypeRequestRequestTypeDef definition

class GetQualificationTypeRequestRequestTypeDef(TypedDict):
    QualificationTypeId: str,

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef definition

class PaginatorConfigTypeDef(TypedDict):
    MaxItems: NotRequired[int],
    PageSize: NotRequired[int],
    StartingToken: NotRequired[str],

ListAssignmentsForHITRequestRequestTypeDef#

# ListAssignmentsForHITRequestRequestTypeDef definition

class ListAssignmentsForHITRequestRequestTypeDef(TypedDict):
    HITId: str,
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],
    AssignmentStatuses: NotRequired[Sequence[AssignmentStatusType]],  # (1)
  1. See AssignmentStatusType

ListBonusPaymentsRequestRequestTypeDef#

# ListBonusPaymentsRequestRequestTypeDef definition

class ListBonusPaymentsRequestRequestTypeDef(TypedDict):
    HITId: NotRequired[str],
    AssignmentId: NotRequired[str],
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],

ListHITsForQualificationTypeRequestRequestTypeDef#

# ListHITsForQualificationTypeRequestRequestTypeDef definition

class ListHITsForQualificationTypeRequestRequestTypeDef(TypedDict):
    QualificationTypeId: str,
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],

ListHITsRequestRequestTypeDef#

# ListHITsRequestRequestTypeDef definition

class ListHITsRequestRequestTypeDef(TypedDict):
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],

ListQualificationRequestsRequestRequestTypeDef#

# ListQualificationRequestsRequestRequestTypeDef definition

class ListQualificationRequestsRequestRequestTypeDef(TypedDict):
    QualificationTypeId: NotRequired[str],
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],

QualificationRequestTypeDef#

# QualificationRequestTypeDef definition

class QualificationRequestTypeDef(TypedDict):
    QualificationRequestId: NotRequired[str],
    QualificationTypeId: NotRequired[str],
    WorkerId: NotRequired[str],
    Test: NotRequired[str],
    Answer: NotRequired[str],
    SubmitTime: NotRequired[datetime],

ListQualificationTypesRequestRequestTypeDef#

# ListQualificationTypesRequestRequestTypeDef definition

class ListQualificationTypesRequestRequestTypeDef(TypedDict):
    MustBeRequestable: bool,
    Query: NotRequired[str],
    MustBeOwnedByCaller: NotRequired[bool],
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],

ListReviewPolicyResultsForHITRequestRequestTypeDef#

# ListReviewPolicyResultsForHITRequestRequestTypeDef definition

class ListReviewPolicyResultsForHITRequestRequestTypeDef(TypedDict):
    HITId: str,
    PolicyLevels: NotRequired[Sequence[ReviewPolicyLevelType]],  # (1)
    RetrieveActions: NotRequired[bool],
    RetrieveResults: NotRequired[bool],
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],
  1. See ReviewPolicyLevelType

ListReviewableHITsRequestRequestTypeDef#

# ListReviewableHITsRequestRequestTypeDef definition

class ListReviewableHITsRequestRequestTypeDef(TypedDict):
    HITTypeId: NotRequired[str],
    Status: NotRequired[ReviewableHITStatusType],  # (1)
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],
  1. See ReviewableHITStatusType

ListWorkerBlocksRequestRequestTypeDef#

# ListWorkerBlocksRequestRequestTypeDef definition

class ListWorkerBlocksRequestRequestTypeDef(TypedDict):
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],

WorkerBlockTypeDef#

# WorkerBlockTypeDef definition

class WorkerBlockTypeDef(TypedDict):
    WorkerId: NotRequired[str],
    Reason: NotRequired[str],

ListWorkersWithQualificationTypeRequestRequestTypeDef#

# ListWorkersWithQualificationTypeRequestRequestTypeDef definition

class ListWorkersWithQualificationTypeRequestRequestTypeDef(TypedDict):
    QualificationTypeId: str,
    Status: NotRequired[QualificationStatusType],  # (1)
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],
  1. See QualificationStatusType

LocaleTypeDef#

# LocaleTypeDef definition

class LocaleTypeDef(TypedDict):
    Country: str,
    Subdivision: NotRequired[str],

NotificationSpecificationTypeDef#

# NotificationSpecificationTypeDef definition

class NotificationSpecificationTypeDef(TypedDict):
    Destination: str,
    Transport: NotificationTransportType,  # (1)
    Version: str,
    EventTypes: Sequence[EventTypeType],  # (2)
  1. See NotificationTransportType
  2. See EventTypeType

NotifyWorkersFailureStatusTypeDef#

# NotifyWorkersFailureStatusTypeDef definition

class NotifyWorkersFailureStatusTypeDef(TypedDict):
    NotifyWorkersFailureCode: NotRequired[NotifyWorkersFailureCodeType],  # (1)
    NotifyWorkersFailureMessage: NotRequired[str],
    WorkerId: NotRequired[str],
  1. See NotifyWorkersFailureCodeType

NotifyWorkersRequestRequestTypeDef#

# NotifyWorkersRequestRequestTypeDef definition

class NotifyWorkersRequestRequestTypeDef(TypedDict):
    Subject: str,
    MessageText: str,
    WorkerIds: Sequence[str],

ParameterMapEntryTypeDef#

# ParameterMapEntryTypeDef definition

class ParameterMapEntryTypeDef(TypedDict):
    Key: NotRequired[str],
    Values: NotRequired[Sequence[str]],

RejectAssignmentRequestRequestTypeDef#

# RejectAssignmentRequestRequestTypeDef definition

class RejectAssignmentRequestRequestTypeDef(TypedDict):
    AssignmentId: str,
    RequesterFeedback: str,

RejectQualificationRequestRequestRequestTypeDef#

# RejectQualificationRequestRequestRequestTypeDef definition

class RejectQualificationRequestRequestRequestTypeDef(TypedDict):
    QualificationRequestId: str,
    Reason: NotRequired[str],

ReviewActionDetailTypeDef#

# ReviewActionDetailTypeDef definition

class ReviewActionDetailTypeDef(TypedDict):
    ActionId: NotRequired[str],
    ActionName: NotRequired[str],
    TargetId: NotRequired[str],
    TargetType: NotRequired[str],
    Status: NotRequired[ReviewActionStatusType],  # (1)
    CompleteTime: NotRequired[datetime],
    Result: NotRequired[str],
    ErrorCode: NotRequired[str],
  1. See ReviewActionStatusType

ReviewResultDetailTypeDef#

# ReviewResultDetailTypeDef definition

class ReviewResultDetailTypeDef(TypedDict):
    ActionId: NotRequired[str],
    SubjectId: NotRequired[str],
    SubjectType: NotRequired[str],
    QuestionId: NotRequired[str],
    Key: NotRequired[str],
    Value: NotRequired[str],

SendBonusRequestRequestTypeDef#

# SendBonusRequestRequestTypeDef definition

class SendBonusRequestRequestTypeDef(TypedDict):
    WorkerId: str,
    BonusAmount: str,
    AssignmentId: str,
    Reason: str,
    UniqueRequestToken: NotRequired[str],

UpdateHITReviewStatusRequestRequestTypeDef#

# UpdateHITReviewStatusRequestRequestTypeDef definition

class UpdateHITReviewStatusRequestRequestTypeDef(TypedDict):
    HITId: str,
    Revert: NotRequired[bool],

UpdateHITTypeOfHITRequestRequestTypeDef#

# UpdateHITTypeOfHITRequestRequestTypeDef definition

class UpdateHITTypeOfHITRequestRequestTypeDef(TypedDict):
    HITId: str,
    HITTypeId: str,

UpdateQualificationTypeRequestRequestTypeDef#

# UpdateQualificationTypeRequestRequestTypeDef definition

class UpdateQualificationTypeRequestRequestTypeDef(TypedDict):
    QualificationTypeId: str,
    Description: NotRequired[str],
    QualificationTypeStatus: NotRequired[QualificationTypeStatusType],  # (1)
    Test: NotRequired[str],
    AnswerKey: NotRequired[str],
    TestDurationInSeconds: NotRequired[int],
    RetryDelayInSeconds: NotRequired[int],
    AutoGranted: NotRequired[bool],
    AutoGrantedValue: NotRequired[int],
  1. See QualificationTypeStatusType

CreateHITTypeResponseTypeDef#

# CreateHITTypeResponseTypeDef definition

class CreateHITTypeResponseTypeDef(TypedDict):
    HITTypeId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

GetAccountBalanceResponseTypeDef#

# GetAccountBalanceResponseTypeDef definition

class GetAccountBalanceResponseTypeDef(TypedDict):
    AvailableBalance: str,
    OnHoldBalance: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

GetFileUploadURLResponseTypeDef#

# GetFileUploadURLResponseTypeDef definition

class GetFileUploadURLResponseTypeDef(TypedDict):
    FileUploadURL: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ListAssignmentsForHITResponseTypeDef#

# ListAssignmentsForHITResponseTypeDef definition

class ListAssignmentsForHITResponseTypeDef(TypedDict):
    NextToken: str,
    NumResults: int,
    Assignments: List[AssignmentTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AssignmentTypeDef
  2. See ResponseMetadataTypeDef

ListBonusPaymentsResponseTypeDef#

# ListBonusPaymentsResponseTypeDef definition

class ListBonusPaymentsResponseTypeDef(TypedDict):
    NumResults: int,
    NextToken: str,
    BonusPayments: List[BonusPaymentTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See BonusPaymentTypeDef
  2. See ResponseMetadataTypeDef

CreateQualificationTypeResponseTypeDef#

# CreateQualificationTypeResponseTypeDef definition

class CreateQualificationTypeResponseTypeDef(TypedDict):
    QualificationType: QualificationTypeTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See QualificationTypeTypeDef
  2. See ResponseMetadataTypeDef

GetQualificationTypeResponseTypeDef#

# GetQualificationTypeResponseTypeDef definition

class GetQualificationTypeResponseTypeDef(TypedDict):
    QualificationType: QualificationTypeTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See QualificationTypeTypeDef
  2. See ResponseMetadataTypeDef

ListQualificationTypesResponseTypeDef#

# ListQualificationTypesResponseTypeDef definition

class ListQualificationTypesResponseTypeDef(TypedDict):
    NumResults: int,
    NextToken: str,
    QualificationTypes: List[QualificationTypeTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See QualificationTypeTypeDef
  2. See ResponseMetadataTypeDef

UpdateQualificationTypeResponseTypeDef#

# UpdateQualificationTypeResponseTypeDef definition

class UpdateQualificationTypeResponseTypeDef(TypedDict):
    QualificationType: QualificationTypeTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See QualificationTypeTypeDef
  2. See ResponseMetadataTypeDef

ListAssignmentsForHITRequestListAssignmentsForHITPaginateTypeDef#

# ListAssignmentsForHITRequestListAssignmentsForHITPaginateTypeDef definition

class ListAssignmentsForHITRequestListAssignmentsForHITPaginateTypeDef(TypedDict):
    HITId: str,
    AssignmentStatuses: NotRequired[Sequen