DeviceFarm / Paginator / ListOfferings

ListOfferings

class DeviceFarm.Paginator.ListOfferings

paginator = client.get_paginator('list_offerings')

paginate(**kwargs)

Creates an iterator that will paginate through responses from DeviceFarm.Client.list_offerings().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    PaginationConfig={
        'MaxItems': 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.

• StartingToken (string) –

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

Return type:

dict

Returns:

Response Syntax

{
    'offerings': [
        {
            'id': 'string',
            'description': 'string',
            'type': 'RECURRING',
            'platform': 'ANDROID'|'IOS',
            'recurringCharges': [
                {
                    'cost': {
                        'amount': 123.0,
                        'currencyCode': 'USD'
                    },
                    'frequency': 'MONTHLY'
                },
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  Represents the return values of the list of offerings.

  • offerings (list) –

    A value that represents the list offering results.

    • (dict) –

      Represents the metadata of a device offering.

      • id (string) –

        The ID that corresponds to a device offering.

      • description (string) –

        A string that describes the offering.

      • type (string) –

        The type of offering (for example, RECURRING) for a device.

      • platform (string) –

        The platform of the device (for example, ANDROID or IOS).

      • recurringCharges (list) –

        Specifies whether there are recurring charges for the offering.

        • (dict) –

          Specifies whether charges for devices are recurring.

          • cost (dict) –

            The cost of the recurring charge.

            • amount (float) –

              The numerical amount of an offering or transaction.

            • currencyCode (string) –

              The currency code of a monetary amount. For example, USD means U.S. dollars.

          • frequency (string) –

            The frequency in which charges recur.

  • NextToken (string) –

    A token to resume pagination.