MTurk / Client / get_account_balance

get_account_balance#

MTurk.Client.get_account_balance()#

The GetAccountBalance operation retrieves the Prepaid HITs balance in your Amazon Mechanical Turk account if you are a Prepaid Requester. Alternatively, this operation will retrieve the remaining available AWS Billing usage if you have enabled AWS Billing. Note: If you have enabled AWS Billing and still have a remaining Prepaid HITs balance, this balance can be viewed on the My Account page in the Requester console.

See also: AWS API Documentation

Request Syntax

response = client.get_account_balance()
Return type:

dict

Returns:

Response Syntax

{
    'AvailableBalance': 'string',
    'OnHoldBalance': 'string'
}

Response Structure

  • (dict) –

    • AvailableBalance (string) –

      A string representing a currency amount.

    • OnHoldBalance (string) –

      A string representing a currency amount.

Exceptions

  • MTurk.Client.exceptions.ServiceFault

  • MTurk.Client.exceptions.RequestError