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,
]

ParameterMapEntryUnionTypeDef#

# ParameterMapEntryUnionTypeDef definition

ParameterMapEntryUnionTypeDef = Union[
    ParameterMapEntryTypeDef,  # (1)
    ParameterMapEntryOutputTypeDef,  # (2)
]
  1. See ParameterMapEntryTypeDef
  2. See ParameterMapEntryOutputTypeDef

QualificationRequirementUnionTypeDef#

# QualificationRequirementUnionTypeDef definition

QualificationRequirementUnionTypeDef = Union[
    QualificationRequirementTypeDef,  # (1)
    QualificationRequirementOutputTypeDef,  # (2)
]
  1. See QualificationRequirementTypeDef
  2. See QualificationRequirementOutputTypeDef

PolicyParameterUnionTypeDef#

# PolicyParameterUnionTypeDef definition

PolicyParameterUnionTypeDef = Union[
    PolicyParameterTypeDef,  # (1)
    PolicyParameterOutputTypeDef,  # (2)
]
  1. See PolicyParameterTypeDef
  2. See PolicyParameterOutputTypeDef

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],

ParameterMapEntryOutputTypeDef#

# ParameterMapEntryOutputTypeDef definition

class ParameterMapEntryOutputTypeDef(TypedDict):
    Key: NotRequired[str],
    Values: NotRequired[list[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):
    NumResults: int,
    Assignments: list[AssignmentTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See AssignmentTypeDef
  2. See ResponseMetadataTypeDef

ListBonusPaymentsResponseTypeDef#

# ListBonusPaymentsResponseTypeDef definition

class ListBonusPaymentsResponseTypeDef(TypedDict):
    NumResults: int,
    BonusPayments: list[BonusPaymentTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  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,
    QualificationTypes: list[QualificationTypeTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See QualificationTypeTypeDef
  2. See ResponseMetadataTypeDef

UpdateQualificationTypeResponseTypeDef#

# UpdateQualificationTypeResponseTypeDef definition

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

ListAssignmentsForHITRequestPaginateTypeDef#

# ListAssignmentsForHITRequestPaginateTypeDef definition

class ListAssignmentsForHITRequestPaginateTypeDef(TypedDict):
    HITId: str,
    AssignmentStatuses: NotRequired[Sequence[AssignmentStatusType]],  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See AssignmentStatusType
  2. See PaginatorConfigTypeDef

ListBonusPaymentsRequestPaginateTypeDef#

# ListBonusPaymentsRequestPaginateTypeDef definition

class ListBonusPaymentsRequestPaginateTypeDef(TypedDict):
    HITId: NotRequired[str],
    AssignmentId: NotRequired[str],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListHITsForQualificationTypeRequestPaginateTypeDef#

# ListHITsForQualificationTypeRequestPaginateTypeDef definition

class ListHITsForQualificationTypeRequestPaginateTypeDef(TypedDict):
    QualificationTypeId: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListHITsRequestPaginateTypeDef#

# ListHITsRequestPaginateTypeDef definition

class ListHITsRequestPaginateTypeDef(TypedDict):
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListQualificationRequestsRequestPaginateTypeDef#

# ListQualificationRequestsRequestPaginateTypeDef definition

class ListQualificationRequestsRequestPaginateTypeDef(TypedDict):
    QualificationTypeId: NotRequired[str],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListQualificationTypesRequestPaginateTypeDef#

# ListQualificationTypesRequestPaginateTypeDef definition

class ListQualificationTypesRequestPaginateTypeDef(TypedDict):
    MustBeRequestable: bool,
    Query: NotRequired[str],
    MustBeOwnedByCaller: NotRequired[bool],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListReviewableHITsRequestPaginateTypeDef#

# ListReviewableHITsRequestPaginateTypeDef definition

class ListReviewableHITsRequestPaginateTypeDef(TypedDict):
    HITTypeId: NotRequired[str],
    Status: NotRequired[ReviewableHITStatusType],  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See ReviewableHITStatusType
  2. See PaginatorConfigTypeDef

ListWorkerBlocksRequestPaginateTypeDef#

# ListWorkerBlocksRequestPaginateTypeDef definition

class ListWorkerBlocksRequestPaginateTypeDef(TypedDict):
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListWorkersWithQualificationTypeRequestPaginateTypeDef#

# ListWorkersWithQualificationTypeRequestPaginateTypeDef definition

class ListWorkersWithQualificationTypeRequestPaginateTypeDef(TypedDict):
    QualificationTypeId: str,
    Status: NotRequired[QualificationStatusType],  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See QualificationStatusType
  2. See PaginatorConfigTypeDef

ListQualificationRequestsResponseTypeDef#

# ListQualificationRequestsResponseTypeDef definition

class ListQualificationRequestsResponseTypeDef(TypedDict):
    NumResults: int,
    QualificationRequests: list[QualificationRequestTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See QualificationRequestTypeDef
  2. See ResponseMetadataTypeDef

ListWorkerBlocksResponseTypeDef#

# ListWorkerBlocksResponseTypeDef definition

class ListWorkerBlocksResponseTypeDef(TypedDict):
    NumResults: int,
    WorkerBlocks: list[WorkerBlockTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See WorkerBlockTypeDef
  2. See ResponseMetadataTypeDef

QualificationRequirementOutputTypeDef#

# QualificationRequirementOutputTypeDef definition

class QualificationRequirementOutputTypeDef(TypedDict):
    QualificationTypeId: str,
    Comparator: ComparatorType,  # (1)
    IntegerValues: NotRequired[list[int]],
    LocaleValues: NotRequired[list[LocaleTypeDef]],  # (2)
    RequiredToPreview: NotRequired[bool],
    ActionsGuarded: NotRequired[HITAccessActionsType],  # (3)
  1. See ComparatorType
  2. See LocaleTypeDef
  3. See HITAccessActionsType

QualificationRequirementTypeDef#

# QualificationRequirementTypeDef definition

class QualificationRequirementTypeDef(TypedDict):
    QualificationTypeId: str,
    Comparator: ComparatorType,  # (1)
    IntegerValues: NotRequired[Sequence[int]],
    LocaleValues: NotRequired[Sequence[LocaleTypeDef]],  # (2)
    RequiredToPreview: NotRequired[bool],
    ActionsGuarded: NotRequired[HITAccessActionsType],  # (3)
  1. See ComparatorType
  2. See LocaleTypeDef
  3. See HITAccessActionsType

QualificationTypeDef#

# QualificationTypeDef definition

class QualificationTypeDef(TypedDict):
    QualificationTypeId: NotRequired[str],
    WorkerId: NotRequired[str],
    GrantTime: NotRequired[datetime],
    IntegerValue: NotRequired[int],
    LocaleValue: NotRequired[LocaleTypeDef],  # (1)
    Status: NotRequired[QualificationStatusType],  # (2)
  1. See LocaleTypeDef
  2. See QualificationStatusType

SendTestEventNotificationRequestRequestTypeDef#

# SendTestEventNotificationRequestRequestTypeDef definition

class SendTestEventNotificationRequestRequestTypeDef(TypedDict):
    Notification: NotificationSpecificationTypeDef,  # (1)
    TestEventType: EventTypeType,  # (2)
  1. See NotificationSpecificationTypeDef
  2. See EventTypeType

UpdateNotificationSettingsRequestRequestTypeDef#

# UpdateNotificationSettingsRequestRequestTypeDef definition

class UpdateNotificationSettingsRequestRequestTypeDef(TypedDict):
    HITTypeId: str,
    Notification: NotRequired[NotificationSpecificationTypeDef],  # (1)
    Active: NotRequired[bool],
  1. See NotificationSpecificationTypeDef

NotifyWorkersResponseTypeDef#

# NotifyWorkersResponseTypeDef definition

class NotifyWorkersResponseTypeDef(TypedDict):
    NotifyWorkersFailureStatuses: list[NotifyWorkersFailureStatusTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See NotifyWorkersFailureStatusTypeDef
  2. See ResponseMetadataTypeDef

PolicyParameterOutputTypeDef#

# PolicyParameterOutputTypeDef definition

class PolicyParameterOutputTypeDef(TypedDict):
    Key: NotRequired[str],
    Values: NotRequired[list[str]],
    MapEntries: NotRequired[list[ParameterMapEntryOutputTypeDef]],  # (1)
  1. See ParameterMapEntryOutputTypeDef

ReviewReportTypeDef#

# ReviewReportTypeDef definition

class ReviewReportTypeDef(TypedDict):
    ReviewResults: NotRequired[list[ReviewResultDetailTypeDef]],  # (1)
    ReviewActions: NotRequired[list[ReviewActionDetailTypeDef]],  # (2)
  1. See ReviewResultDetailTypeDef
  2. See ReviewActionDetailTypeDef

UpdateExpirationForHITRequestRequestTypeDef#

# UpdateExpirationForHITRequestRequestTypeDef definition

class UpdateExpirationForHITRequestRequestTypeDef(TypedDict):
    HITId: str,
    ExpireAt: TimestampTypeDef,

HITTypeDef#

# HITTypeDef definition

class HITTypeDef(TypedDict):
    HITId: NotRequired[str],
    HITTypeId: NotRequired[str],
    HITGroupId: NotRequired[str],
    HITLayoutId: NotRequired[str],
    CreationTime: NotRequired[datetime],
    Title: NotRequired[str],
    Description: NotRequired[str],
    Question: NotRequired[str],
    Keywords: NotRequired[str],
    HITStatus: NotRequired[HITStatusType],  # (1)
    MaxAssignments: NotRequired[int],
    Reward: NotRequired[str],
    AutoApprovalDelayInSeconds: NotRequired[int],
    Expiration: NotRequired[datetime],
    AssignmentDurationInSeconds: NotRequired[int],
    RequesterAnnotation: NotRequired[str],
    QualificationRequirements: NotRequired[list[QualificationRequirementOutputTypeDef]],  # (2)
    HITReviewStatus: NotRequired[HITReviewStatusType],  # (3)
    NumberOfAssignmentsPending: NotRequired[int],
    NumberOfAssignmentsAvailable: NotRequired[int],
    NumberOfAssignmentsCompleted: NotRequired[int],
  1. See HITStatusType
  2. See QualificationRequirementOutputTypeDef
  3. See HITReviewStatusType

CreateHITTypeRequestRequestTypeDef#

# CreateHITTypeRequestRequestTypeDef definition

class CreateHITTypeRequestRequestTypeDef(TypedDict):
    AssignmentDurationInSeconds: int,
    Reward: str,
    Title: str,
    Description: str,
    AutoApprovalDelayInSeconds: NotRequired[int],
    Keywords: NotRequired[str],
    QualificationRequirements: NotRequired[Sequence[QualificationRequirementTypeDef]],  # (1)
  1. See QualificationRequirementTypeDef

GetQualificationScoreResponseTypeDef#

# GetQualificationScoreResponseTypeDef definition

class GetQualificationScoreResponseTypeDef(TypedDict):
    Qualification: QualificationTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See QualificationTypeDef
  2. See ResponseMetadataTypeDef

ListWorkersWithQualificationTypeResponseTypeDef#

# ListWorkersWithQualificationTypeResponseTypeDef definition

class ListWorkersWithQualificationTypeResponseTypeDef(TypedDict):
    NumResults: int,
    Qualifications: list[QualificationTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See QualificationTypeDef
  2. See ResponseMetadataTypeDef

ReviewPolicyOutputTypeDef#

# ReviewPolicyOutputTypeDef definition

class ReviewPolicyOutputTypeDef(TypedDict):
    PolicyName: str,
    Parameters: NotRequired[list[PolicyParameterOutputTypeDef]],  # (1)
  1. See PolicyParameterOutputTypeDef

PolicyParameterTypeDef#

# PolicyParameterTypeDef definition

class PolicyParameterTypeDef(TypedDict):
    Key: NotRequired[str],
    Values: NotRequired[Sequence[str]],
    MapEntries: NotRequired[Sequence[ParameterMapEntryUnionTypeDef]],  # (1)
  1. See ParameterMapEntryTypeDef ParameterMapEntryOutputTypeDef

CreateHITResponseTypeDef#

# CreateHITResponseTypeDef definition

class CreateHITResponseTypeDef(TypedDict):
    HIT: HITTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See HITTypeDef
  2. See ResponseMetadataTypeDef

CreateHITWithHITTypeResponseTypeDef#

# CreateHITWithHITTypeResponseTypeDef definition

class CreateHITWithHITTypeResponseTypeDef(TypedDict):
    HIT: HITTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See HITTypeDef
  2. See ResponseMetadataTypeDef

GetAssignmentResponseTypeDef#

# GetAssignmentResponseTypeDef definition

class GetAssignmentResponseTypeDef(TypedDict):
    Assignment: AssignmentTypeDef,  # (1)
    HIT: HITTypeDef,  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See AssignmentTypeDef
  2. See HITTypeDef
  3. See ResponseMetadataTypeDef

GetHITResponseTypeDef#

# GetHITResponseTypeDef definition

class GetHITResponseTypeDef(TypedDict):
    HIT: HITTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See HITTypeDef
  2. See ResponseMetadataTypeDef

ListHITsForQualificationTypeResponseTypeDef#

# ListHITsForQualificationTypeResponseTypeDef definition

class ListHITsForQualificationTypeResponseTypeDef(TypedDict):
    NumResults: int,
    HITs: list[HITTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See HITTypeDef
  2. See ResponseMetadataTypeDef

ListHITsResponseTypeDef#

# ListHITsResponseTypeDef definition

class ListHITsResponseTypeDef(TypedDict):
    NumResults: int,
    HITs: list[HITTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See HITTypeDef
  2. See ResponseMetadataTypeDef

ListReviewableHITsResponseTypeDef#

# ListReviewableHITsResponseTypeDef definition

class ListReviewableHITsResponseTypeDef(TypedDict):
    NumResults: int,
    HITs: list[HITTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See HITTypeDef
  2. See ResponseMetadataTypeDef

ListReviewPolicyResultsForHITResponseTypeDef#

# ListReviewPolicyResultsForHITResponseTypeDef definition

class ListReviewPolicyResultsForHITResponseTypeDef(TypedDict):
    HITId: str,
    AssignmentReviewPolicy: ReviewPolicyOutputTypeDef,  # (1)
    HITReviewPolicy: ReviewPolicyOutputTypeDef,  # (1)
    AssignmentReviewReport: ReviewReportTypeDef,  # (3)
    HITReviewReport: ReviewReportTypeDef,  # (3)
    ResponseMetadata: ResponseMetadataTypeDef,  # (5)
    NextToken: NotRequired[str],
  1. See ReviewPolicyOutputTypeDef
  2. See ReviewPolicyOutputTypeDef
  3. See ReviewReportTypeDef
  4. See ReviewReportTypeDef
  5. See ResponseMetadataTypeDef

ReviewPolicyTypeDef#

# ReviewPolicyTypeDef definition

class ReviewPolicyTypeDef(TypedDict):
    PolicyName: str,
    Parameters: NotRequired[Sequence[PolicyParameterUnionTypeDef]],  # (1)
  1. See PolicyParameterTypeDef PolicyParameterOutputTypeDef

CreateHITRequestRequestTypeDef#

# CreateHITRequestRequestTypeDef definition

class CreateHITRequestRequestTypeDef(TypedDict):
    LifetimeInSeconds: int,
    AssignmentDurationInSeconds: int,
    Reward: str,
    Title: str,
    Description: str,
    MaxAssignments: NotRequired[int],
    AutoApprovalDelayInSeconds: NotRequired[int],
    Keywords: NotRequired[str],
    Question: NotRequired[str],
    RequesterAnnotation: NotRequired[str],
    QualificationRequirements: NotRequired[Sequence[QualificationRequirementUnionTypeDef]],  # (1)
    UniqueRequestToken: NotRequired[str],
    AssignmentReviewPolicy: NotRequired[ReviewPolicyTypeDef],  # (2)
    HITReviewPolicy: NotRequired[ReviewPolicyTypeDef],  # (2)
    HITLayoutId: NotRequired[str],
    HITLayoutParameters: NotRequired[Sequence[HITLayoutParameterTypeDef]],  # (4)
  1. See QualificationRequirementTypeDef QualificationRequirementOutputTypeDef
  2. See ReviewPolicyTypeDef
  3. See ReviewPolicyTypeDef
  4. See HITLayoutParameterTypeDef

CreateHITWithHITTypeRequestRequestTypeDef#

# CreateHITWithHITTypeRequestRequestTypeDef definition

class CreateHITWithHITTypeRequestRequestTypeDef(TypedDict):
    HITTypeId: str,
    LifetimeInSeconds: int,
    MaxAssignments: NotRequired[int],
    Question: NotRequired[str],
    RequesterAnnotation: NotRequired[str],
    UniqueRequestToken: NotRequired[str],
    AssignmentReviewPolicy: NotRequired[ReviewPolicyTypeDef],  # (1)
    HITReviewPolicy: NotRequired[ReviewPolicyTypeDef],  # (1)
    HITLayoutId: NotRequired[str],
    HITLayoutParameters: NotRequired[Sequence[HITLayoutParameterTypeDef]],  # (3)
  1. See ReviewPolicyTypeDef
  2. See ReviewPolicyTypeDef
  3. See HITLayoutParameterTypeDef