Amazon Mechanical Turk #X Amz Target=MTurkRequesterServiceV20170117.ListBonusPayments API

openapi: 3.2.0
info:
  version: 1.0.0
  x-release: v4
  title: 'Amazon Mechanical Turk #X Amz Target=MTurkRequesterServiceV20170117.AcceptQualificationRequest #X Amz Target=MTurkRequesterServiceV20170117.AcceptQualificationRequest #X Amz Target=MTurkRequesterServiceV20170117.ListBonusPayments #X Amz Target=MTurkRequesterServiceV20170117.ListBonusPayments #X Amz Target=MTurkRequesterServiceV20170117.ListBonusPayments API'
  description: <fullname>Amazon Mechanical Turk API Reference</fullname>
  x-logo:
    url: https://twitter.com/awscloud/profile_image?size=original
    backgroundColor: '#FFFFFF'
  termsOfService: https://aws.amazon.com/service-terms/
  contact:
    name: Mike Ralphson
    email: mike.ralphson@gmail.com
    url: https://github.com/mermade/aws2openapi
    x-twitter: PermittedSoc
  license:
    name: Apache 2.0 License
    url: http://www.apache.org/licenses/
  x-providerName: amazonaws.com
  x-serviceName: mturk-requester
  x-origin:
  - contentType: application/json
    url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/mturk-requester-2017-01-17.normal.json
    converter:
      url: https://github.com/mermade/aws2openapi
    x-apisguru-driver: external
  x-apiClientRegistration:
    url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct
  x-apisguru-categories:
  - cloud
  x-preferred: true
servers:
- url: http://mturk-requester.{region}.amazonaws.com
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The Amazon MTurk multi-region endpoint
- url: https://mturk-requester.{region}.amazonaws.com
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The Amazon MTurk multi-region endpoint
- url: http://mturk-requester.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The Amazon MTurk endpoint for China (Beijing) and China (Ningxia)
- url: https://mturk-requester.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The Amazon MTurk endpoint for China (Beijing) and China (Ningxia)
security:
- hmac: []
tags:
- name: '#X Amz Target=MTurkRequesterServiceV20170117.ListBonusPayments'
paths:
  /#X-Amz-Target=MTurkRequesterServiceV20170117.ListBonusPayments:
    parameters:
    - $ref: '#/components/parameters/X-Amz-Content-Sha256'
    - $ref: '#/components/parameters/X-Amz-Date'
    - $ref: '#/components/parameters/X-Amz-Algorithm'
    - $ref: '#/components/parameters/X-Amz-Credential'
    - $ref: '#/components/parameters/X-Amz-Security-Token'
    - $ref: '#/components/parameters/X-Amz-Signature'
    - $ref: '#/components/parameters/X-Amz-SignedHeaders'
    post:
      operationId: ListBonusPayments
      description: ' The <code>ListBonusPayments</code> operation retrieves the amounts of bonuses you have paid to Workers for a given HIT or assignment. '
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListBonusPaymentsResponse'
        '480':
          description: ServiceFault
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceFault'
        '481':
          description: RequestError
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RequestError'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListBonusPaymentsRequest'
      parameters:
      - name: MaxResults
        in: query
        schema:
          type: string
        description: Pagination limit
        required: false
      - name: NextToken
        in: query
        schema:
          type: string
        description: Pagination token
        required: false
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - MTurkRequesterServiceV20170117.ListBonusPayments
      summary: Amazon Mechanical Turk List Bonus Payments
      tags:
      - '#X Amz Target=MTurkRequesterServiceV20170117.ListBonusPayments'
components:
  schemas:
    EntityId:
      type: string
      pattern: ^[A-Z0-9]+$
      minLength: 1
      maxLength: 64
    Integer:
      type: integer
    ListBonusPaymentsResponse:
      type: object
      properties:
        NumResults:
          allOf:
          - $ref: '#/components/schemas/Integer'
          - description: 'The number of bonus payments on this page in the filtered results list, equivalent to the number of bonus payments being returned by this call. '
        NextToken:
          $ref: '#/components/schemas/PaginationToken'
        BonusPayments:
          allOf:
          - $ref: '#/components/schemas/BonusPaymentList'
          - description: 'A successful request to the ListBonusPayments operation returns a list of BonusPayment objects. '
    PaginationToken:
      type: string
      description: 'If the previous response was incomplete (because there is more data to retrieve), Amazon Mechanical Turk returns a pagination token in the response. You can use this pagination token to retrieve the next set of results. '
      minLength: 1
      maxLength: 255
    CurrencyAmount:
      type: string
      pattern: ^[0-9]+(\.)?[0-9]{0,2}$
      description: A string representing a currency amount.
    String:
      type: string
    ServiceFault: {}
    ResultSize:
      type: integer
      minimum: 1
      maximum: 100
    Timestamp:
      type: string
      format: date-time
    BonusPayment:
      type: object
      properties:
        WorkerId:
          allOf:
          - $ref: '#/components/schemas/CustomerId'
          - description: The ID of the Worker to whom the bonus was paid.
        BonusAmount:
          $ref: '#/components/schemas/CurrencyAmount'
        AssignmentId:
          allOf:
          - $ref: '#/components/schemas/EntityId'
          - description: The ID of the assignment associated with this bonus payment.
        Reason:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: The Reason text given when the bonus was granted, if any.
        GrantTime:
          allOf:
          - $ref: '#/components/schemas/Timestamp'
          - description: The date and time of when the bonus was granted.
      description: An object representing a Bonus payment paid to a Worker.
    CustomerId:
      type: string
      pattern: ^A[A-Z0-9]+$
      minLength: 1
      maxLength: 64
    ListBonusPaymentsRequest:
      type: object
      title: ListBonusPaymentsRequest
      properties:
        HITId:
          allOf:
          - $ref: '#/components/schemas/EntityId'
          - description: The ID of the HIT associated with the bonus payments to retrieve. If not specified, all bonus payments for all assignments for the given HIT are returned. Either the HITId parameter or the AssignmentId parameter must be specified
        AssignmentId:
          allOf:
          - $ref: '#/components/schemas/EntityId'
          - description: The ID of the assignment associated with the bonus payments to retrieve. If specified, only bonus payments for the given assignment are returned. Either the HITId parameter or the AssignmentId parameter must be specified
        NextToken:
          allOf:
          - $ref: '#/components/schemas/PaginationToken'
          - description: Pagination token
        MaxResults:
          $ref: '#/components/schemas/ResultSize'
    RequestError: {}
    BonusPaymentList:
      type: array
      items:
        $ref: '#/components/schemas/BonusPayment'
  parameters:
    X-Amz-Credential:
      name: X-Amz-Credential
      in: header
      schema:
        type: string
      required: false
    X-Amz-Algorithm:
      name: X-Amz-Algorithm
      in: header
      schema:
        type: string
      required: false
    X-Amz-Signature:
      name: X-Amz-Signature
      in: header
      schema:
        type: string
      required: false
    X-Amz-Security-Token:
      name: X-Amz-Security-Token
      in: header
      schema:
        type: string
      required: false
    X-Amz-Date:
      name: X-Amz-Date
      in: header
      schema:
        type: string
      required: false
    X-Amz-SignedHeaders:
      name: X-Amz-SignedHeaders
      in: header
      schema:
        type: string
      required: false
    X-Amz-Content-Sha256:
      name: X-Amz-Content-Sha256
      in: header
      schema:
        type: string
      required: false
  securitySchemes:
    hmac:
      type: apiKey
      name: Authorization
      in: header
      description: Amazon Signature authorization v4
      x-amazon-apigateway-authtype: awsSigv4
externalDocs:
  description: Amazon Web Services documentation
  url: https://docs.aws.amazon.com/mturk-requester/
x-hasEquivalentPaths: true