Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-14126767600.8 KB

Gets a set of statistics for queues or farms. Before you can call the <code>GetSessionStatisticsAggregation</code> operation, you must first call the <code>StartSessionsStatisticsAggregation</code> operation. Statistics are available for 1 hour after you call the <code>StartSessionsStatisticsAggregation</code> operation.

get/2023-10-12/farms/{farmId}/sessions-statistics-aggregation#aggregationId

Path parameters

farmIdstring 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 <code>StartSessionsStatisticsAggregation</code> operation.

Query parameters

nextTokenstring

The token for the next set of results, or <code>null</code> to start from the beginning.

maxResultsinteger

The maximum number of results to return. Use this parameter with <code>NextToken</code> to get results as a set of sequential pages.

aggregationIdstring required

The identifier returned by the <code>StartSessionsStatisticsAggregation</code> operation that identifies the aggregated statistics.

Response

Success

status'IN_PROGRESS' | 'TIMEOUT' | 'FAILED' | 'COMPLETED' required
<p>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 <code>StartSessionsStatisticsAggregation</code> operation after you reduce the aggregation time frame, reduce the number of queues or fleets in the aggregation, or increase the period length.</p> <p>If you call the <code>StartSessionsStatisticsAggregation </code> operation when the status is <code>IN_PROGRESS</code>, you will receive a <code>ThrottlingException</code>.</p>
statusMessagestring

A message that describes the status.

nextTokenstring

If Deadline Cloud returns <code>nextToken</code>, then there are more results available. The value of <code>nextToken</code> 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 <code>nextToken</code> is set to <code>null</code>. Each pagination token expires after 24 hours. If you provide a token that isn't valid, then you receive an HTTP 400 <code>ValidationException</code> error.