DeadlineCloud / Client / list_available_metered_products

list_available_metered_products#

DeadlineCloud.Client.list_available_metered_products(**kwargs)#

A list of the available metered products.

Request Syntax

response = client.list_available_metered_products(
    nextToken='string',
    maxResults=123
)

Parameters:

nextToken (string) – The token for the next set of results, or null to start from the beginning.
maxResults (integer) – The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

(dict) –
- meteredProducts (list) –
  
  The metered products.
  - (dict) –
    
    The details of a metered product.
    - productId (string) –
      
      The product ID.
    - family (string) –
      
      The family to which the metered product belongs.
    - vendor (string) –
      
      The vendor.
    - port (integer) –
      
      The port on which the metered product should run.
- 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

DeadlineCloud.Client.exceptions.InternalServerErrorException
DeadlineCloud.Client.exceptions.ThrottlingException