FreeTier / Client / get_account_plan_state

get_account_plan_state

FreeTier.Client.get_account_plan_state()

This returns all of the information related to the state of the account plan related to Free Tier.

See also: AWS API Documentation

Request Syntax

response = client.get_account_plan_state()
Return type:

dict

Returns:

Response Syntax

{
    'accountId': 'string',
    'accountPlanType': 'FREE'|'PAID',
    'accountPlanStatus': 'NOT_STARTED'|'ACTIVE'|'EXPIRED',
    'accountPlanRemainingCredits': {
        'amount': 123.0,
        'unit': 'USD'
    },
    'accountPlanExpirationDate': datetime(2015, 1, 1)
}

Response Structure

  • (dict) –

    • accountId (string) –

      A unique identifier that identifies the account.

    • accountPlanType (string) –

      The plan type for the account.

    • accountPlanStatus (string) –

      The current status for the account plan.

    • accountPlanRemainingCredits (dict) –

      The amount of credits remaining for the account.

      • amount (float) –

        The aggregated monetary amount of credits earned.

      • unit (string) –

        The unit that the monetary amount is given in.

    • accountPlanExpirationDate (datetime) –

      The timestamp for when the current account plan expires.

Exceptions