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(
    aggregationId='string',
    farmId='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• aggregationId (string) –

  [REQUIRED]

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

• 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.

• 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': [
        {
            'aggregationEndTime': datetime(2015, 1, 1),
            'aggregationStartTime': datetime(2015, 1, 1),
            'costInUsd': {
                'avg': 123.0,
                'max': 123.0,
                'min': 123.0,
                'sum': 123.0
            },
            'count': 123,
            'fleetId': 'string',
            'instanceType': 'string',
            'jobId': 'string',
            'jobName': 'string',
            'licenseProduct': 'string',
            'queueId': 'string',
            'runtimeInSeconds': {
                'avg': 123.0,
                'max': 123.0,
                'min': 123.0,
                'sum': 123.0
            },
            'usageType': 'COMPUTE'|'LICENSE',
            'userId': 'string'
        },
    ],
    '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.

      • aggregationEndTime (datetime) –

        The end time for the aggregation.

      • aggregationStartTime (datetime) –

        The start time for the aggregation.

      • costInUsd (dict) –

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

        • avg (float) –

          The average of the usage statistics.

        • max (float) –

          The maximum among the usage statistics.

        • min (float) –

          The minimum of the usage statistics.

        • sum (float) –

          The sum of the usage statistics.

      • count (integer) –

        The number of instances in a list of statistics.

      • fleetId (string) –

        The fleet ID.

      • instanceType (string) –

        The type of instance.

      • jobId (string) –

        The job ID.

      • jobName (string) –

        The job name.

      • licenseProduct (string) –

        The licensed product.

      • queueId (string) –

        The queue ID.

      • runtimeInSeconds (dict) –

        The total aggregated runtime.

        • avg (float) –

          The average of the usage statistics.

        • max (float) –

          The maximum among the usage statistics.

        • min (float) –

          The minimum of the usage statistics.

        • sum (float) –

          The sum of the usage statistics.

      • usageType (string) –

        The type of usage for the statistics.

      • userId (string) –

        The user ID.

  • status (string) –

    The status of the aggregated results.

  • statusMessage (string) –

    A message that describes the status.

  • NextToken (string) –

    A token to resume pagination.