Mobile / Paginator / ListBundles

ListBundles#

class Mobile.Paginator.ListBundles#
paginator = client.get_paginator('list_bundles')
paginate(**kwargs)#

Creates an iterator that will paginate through responses from Mobile.Client.list_bundles().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters:

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

{
    'bundleList': [
        {
            'bundleId': 'string',
            'title': 'string',
            'version': 'string',
            'description': 'string',
            'iconUrl': 'string',
            'availablePlatforms': [
                'OSX'|'WINDOWS'|'LINUX'|'OBJC'|'SWIFT'|'ANDROID'|'JAVASCRIPT',
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    Result structure contains a list of all available bundles with details.

    • bundleList (list) –

      A list of bundles.

      • (dict) –

        The details of the bundle.

        • bundleId (string) –

          Unique bundle identifier.

        • title (string) –

          Title of the download bundle.

        • version (string) –

          Version of the download bundle.

        • description (string) –

          Description of the download bundle.

        • iconUrl (string) –

          Icon for the download bundle.

        • availablePlatforms (list) –

          Developer desktop or mobile app or website platforms.

          • (string) –

            Developer desktop or target mobile app or website platform.

    • NextToken (string) –

      A token to resume pagination.