DeadlineCloud / Client / list_metered_products

list_metered_products

DeadlineCloud.Client.list_metered_products(**kwargs)

Lists metered products.

See also: AWS API Documentation

Request Syntax

response = client.list_metered_products(
    licenseEndpointId='string',
    maxResults=123,
    nextToken='string'
)
Parameters:

  • licenseEndpointId (string) –

    [REQUIRED]

    The license endpoint ID to include on the list of metered products.

  • maxResults (integer) – The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

  • nextToken (string) – The token for the next set of results, or null to start from the beginning.

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 to list.

      • (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) –

      If Deadline Cloud returns nextToken, then there are more results available. The value of nextToken is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, then nextToken is set to null. Each pagination token expires after 24 hours. If you provide a token that isn’t valid, then you receive an HTTP 400 ValidationException error.

Exceptions