FreeTier / Client / get_account_activity

get_account_activity

FreeTier.Client.get_account_activity(**kwargs)

Returns a specific activity record that is available to the customer.

See also: AWS API Documentation

Request Syntax

response = client.get_account_activity(
    activityId='string',
    languageCode='en-US'|'en-GB'|'id-ID'|'de-DE'|'es-ES'|'fr-FR'|'ja-JP'|'it-IT'|'pt-PT'|'ko-KR'|'zh-CN'|'zh-TW'|'tr-TR'
)
Parameters:

  • activityId (string) –

    [REQUIRED]

    A unique identifier that identifies the activity.

  • languageCode (string) – The language code used to return translated title and description fields.

Return type:

dict

Returns:

Response Syntax

{
    'activityId': 'string',
    'title': 'string',
    'description': 'string',
    'status': 'NOT_STARTED'|'IN_PROGRESS'|'COMPLETED'|'EXPIRING',
    'instructionsUrl': 'string',
    'reward': {
        'credit': {
            'amount': 123.0,
            'unit': 'USD'
        }
    },
    'estimatedTimeToCompleteInMinutes': 123,
    'expiresAt': datetime(2015, 1, 1),
    'startedAt': datetime(2015, 1, 1),
    'completedAt': datetime(2015, 1, 1)
}

Response Structure

  • (dict) –

    • activityId (string) –

      A unique identifier that identifies the activity.

    • title (string) –

      A short activity title.

    • description (string) –

      Provides detailed information about the activity and its expected outcomes.

    • status (string) –

      The current activity status.

    • instructionsUrl (string) –

      The URL resource that provides guidance on activity requirements and completion.

    • reward (dict) –

      A reward granted upon activity completion.

      Note

      This is a Tagged Union structure. Only one of the following top level keys will be set: credit. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

      'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}

      • credit (dict) –

        The credits gained by activity rewards.

        • amount (float) –

          The aggregated monetary amount of credits earned.

        • unit (string) –

          The unit that the monetary amount is given in.

    • estimatedTimeToCompleteInMinutes (integer) –

      The estimated time to complete the activity. This is the duration in minutes.

    • expiresAt (datetime) –

      The time by which the activity must be completed to receive a reward.

    • startedAt (datetime) –

      The timestamp when the activity started. This field appears only for activities in the IN_PROGRESS or COMPLETED states.

    • completedAt (datetime) –

      The timestamp when the activity is completed. This field appears only for activities in the COMPLETED state.

Exceptions