DeadlineCloud / Paginator / GetSessionsStatisticsAggregation

GetSessionsStatisticsAggregation

class DeadlineCloud.Paginator.GetSessionsStatisticsAggregation

paginator = client.get_paginator('get_sessions_statistics_aggregation')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

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

Parameters:

• farmId (string) –

  [REQUIRED]

  The identifier of the farm to include in the statistics. This should be the same as the farm ID used in the call to the StartSessionsStatisticsAggregation operation.

• aggregationId (string) –

  [REQUIRED]

  The identifier returned by the StartSessionsStatisticsAggregation operation that identifies the aggregated statistics.

• 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

{
    'statistics': [
        {
            'queueId': 'string',
            'fleetId': 'string',
            'jobId': 'string',
            'jobName': 'string',
            'userId': 'string',
            'usageType': 'COMPUTE'|'LICENSE',
            'licenseProduct': 'string',
            'instanceType': 'string',
            'count': 123,
            'costInUsd': {
                'min': 123.0,
                'max': 123.0,
                'avg': 123.0,
                'sum': 123.0
            },
            'runtimeInSeconds': {
                'min': 123.0,
                'max': 123.0,
                'avg': 123.0,
                'sum': 123.0
            },
            'aggregationStartTime': datetime(2015, 1, 1),
            'aggregationEndTime': datetime(2015, 1, 1)
        },
    ],
    'status': 'IN_PROGRESS'|'TIMEOUT'|'FAILED'|'COMPLETED',
    'statusMessage': 'string',
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • statistics (list) –

    The statistics for the specified fleets or queues.

    • (dict) –

      A list of statistics for a session.

      • queueId (string) –

        The queue ID.

      • fleetId (string) –

        The fleet ID.

      • jobId (string) –

        The job ID.

      • jobName (string) –

        The job name.

      • userId (string) –

        The user ID.

      • usageType (string) –

        The type of usage for the statistics.

      • licenseProduct (string) –

        The licensed product.

      • instanceType (string) –

        The type of instance.

      • count (integer) –

        The number of instances in a list of statistics.

      • costInUsd (dict) –

        How the statistics should appear in USD. Options include: minimum, maximum, average or sum.

        • min (float) –

          The minimum of the usage statistics.

        • max (float) –

          The maximum among the usage statistics.

        • avg (float) –

          The average of the usage statistics.

        • sum (float) –

          The sum of the usage statistics.

      • runtimeInSeconds (dict) –

        The total aggregated runtime.

        • min (float) –

          The minimum of the usage statistics.

        • max (float) –

          The maximum among the usage statistics.

        • avg (float) –

          The average of the usage statistics.

        • sum (float) –

          The sum of the usage statistics.

      • aggregationStartTime (datetime) –

        The start time for the aggregation.

      • aggregationEndTime (datetime) –

        The end time for the aggregation.

  • status (string) –

    The status of the aggregated results. An aggregation may fail or time out if the results are too large. If this happens, you can call the StartSessionsStatisticsAggregation operation after you reduce the aggregation time frame, reduce the number of queues or fleets in the aggregation, or increase the period length.

    If you call the StartSessionsStatisticsAggregation operation when the status is IN_PROGRESS, you will receive a ThrottlingException.

  • statusMessage (string) –

    A message that describes the status.

  • NextToken (string) –

    A token to resume pagination.