DeadlineCloud / Paginator / ListAvailableMeteredProducts

ListAvailableMeteredProducts

class DeadlineCloud.Paginator.ListAvailableMeteredProducts

paginator = client.get_paginator('list_available_metered_products')

paginate(**kwargs)

Creates an iterator that will paginate through responses from DeadlineCloud.Client.list_available_metered_products().

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

{
    'meteredProducts': [
        {
            'family': 'string',
            'port': 123,
            'productId': 'string',
            'vendor': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • meteredProducts (list) –

    The metered products.

    • (dict) –

      The details of a metered product.

      • family (string) –

        The family to which the metered product belongs.

      • port (integer) –

        The port on which the metered product should run.

      • productId (string) –

        The product ID.

      • vendor (string) –

        The vendor.

  • NextToken (string) –

    A token to resume pagination.