FreeTier / Paginator / ListAccountActivities

ListAccountActivities

class FreeTier.Paginator.ListAccountActivities

paginator = client.get_paginator('list_account_activities')

paginate(**kwargs)

Creates an iterator that will paginate through responses from FreeTier.Client.list_account_activities().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    filterActivityStatuses=[
        'NOT_STARTED'|'IN_PROGRESS'|'COMPLETED'|'EXPIRING',
    ],
    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',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• filterActivityStatuses (list) –

  The activity status filter. This field can be used to filter the response by activities status.

  • (string) –

• languageCode (string) – The language code used to return translated titles.

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'activities': [
        {
            'activityId': 'string',
            'title': 'string',
            'reward': {
                'credit': {
                    'amount': 123.0,
                    'unit': 'USD'
                }
            },
            'status': 'NOT_STARTED'|'IN_PROGRESS'|'COMPLETED'|'EXPIRING'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • activities (list) –

    A brief information about the activities.

    • (dict) –

      The summary of activities.

      • activityId (string) –

        A unique identifier that identifies the activity.

      • title (string) –

        The title of the activity.

      • reward (dict) –

        The reward for the activity.

        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.

      • status (string) –

        The current status of the activity.

  • NextToken (string) –

    A token to resume pagination.