DeadlineCloud / Client / start_sessions_statistics_aggregation

start_sessions_statistics_aggregation#

DeadlineCloud.Client.start_sessions_statistics_aggregation(**kwargs)#

Starts an asynchronous request for getting aggregated statistics about queues and farms. Get the statistics using the GetSessionsStatisticsAggregation operation. You can only have one running aggregation for your Deadline Cloud farm. Call the GetSessionsStatisticsAggregation operation and check the status field to see if an aggregation is running. Statistics are available for 1 hour after you call the StartSessionsStatisticsAggregation operation.

See also: AWS API Documentation

Request Syntax

response = client.start_sessions_statistics_aggregation(
    farmId='string',
    resourceIds={
        'queueIds': [
            'string',
        ],
        'fleetIds': [
            'string',
        ]
    },
    startTime=datetime(2015, 1, 1),
    endTime=datetime(2015, 1, 1),
    timezone='string',
    period='HOURLY'|'DAILY'|'WEEKLY'|'MONTHLY',
    groupBy=[
        'QUEUE_ID'|'FLEET_ID'|'JOB_ID'|'USER_ID'|'USAGE_TYPE'|'INSTANCE_TYPE'|'LICENSE_PRODUCT',
    ],
    statistics=[
        'SUM'|'MIN'|'MAX'|'AVG',
    ]
)
Parameters:

  • farmId (string) –

    [REQUIRED]

    The identifier of the farm that contains queues or fleets to return statistics for.

  • resourceIds (dict) –

    [REQUIRED]

    A list of fleet IDs or queue IDs to gather statistics for.

    Note

    This is a Tagged Union structure. Only one of the following top level keys can be set: queueIds, fleetIds.

    • queueIds (list) –

      One to 10 queue IDs that specify the queues to return statistics for. If you specify the queueIds field, you can’t specify the fleetIds field.

      • (string) –

    • fleetIds (list) –

      One to 10 fleet IDs that specify the fleets to return statistics for. If you specify the fleetIds field, you can’t specify the queueIds field.

      • (string) –

  • startTime (datetime) –

    [REQUIRED]

    The Linux timestamp of the date and time that the statistics start.

  • endTime (datetime) –

    [REQUIRED]

    The Linux timestamp of the date and time that the statistics end.

  • timezone (string) – The timezone to use for the statistics. Use UTC notation such as “UTC+8.”

  • period (string) – The period to aggregate the statistics.

  • groupBy (list) –

    [REQUIRED]

    The field to use to group the statistics.

    • (string) –

  • statistics (list) –

    [REQUIRED]

    One to four statistics to return.

    • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'aggregationId': 'string'
}

Response Structure

  • (dict) –

    • aggregationId (string) –

      A unique identifier for the aggregated statistics. Use this identifier with the GetAggregatedStatisticsForSessions operation to return the statistics.

Exceptions