StartSessionsStatisticsAggregation - AWS Deadline Cloud

StartSessionsStatisticsAggregation

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.

Request Syntax

POST /2023-10-12/farms/farmId/sessions-statistics-aggregation HTTP/1.1 Content-type: application/json { "endTime": "string", "groupBy": [ "string" ], "period": "string", "resourceIds": { ... }, "startTime": "string", "statistics": [ "string" ], "timezone": "string" }

URI Request Parameters

The request uses the following URI parameters.

farmId

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

Pattern: ^farm-[0-9a-f]{32}$

Required: Yes

Request Body

The request accepts the following data in JSON format.

endTime

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

Type: Timestamp

Required: Yes

groupBy

The field to use to group the statistics.

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 2 items.

Valid Values: QUEUE_ID | FLEET_ID | JOB_ID | USER_ID | USAGE_TYPE | INSTANCE_TYPE | LICENSE_PRODUCT

Required: Yes

period

The period to aggregate the statistics.

Type: String

Valid Values: HOURLY | DAILY | WEEKLY | MONTHLY

Required: No

resourceIds

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

Type: SessionsStatisticsResources object

Note: This object is a Union. Only one member of this object can be specified or returned.

Required: Yes

startTime

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

Type: Timestamp

Required: Yes

statistics

One to four statistics to return.

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 4 items.

Valid Values: SUM | MIN | MAX | AVG

Required: Yes

timezone

The timezone to use for the statistics. Use UTC notation such as "UTC+8."

Type: String

Length Constraints: Fixed length of 9.

Pattern: ^UTC[-+][01][0-9]:(30|00)$

Required: No

Response Syntax

HTTP/1.1 200 Content-type: application/json { "aggregationId": "string" }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

aggregationId

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

Type: String

Pattern: ^[0-9a-f]{32}$

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You don't have permission to perform the action.

HTTP Status Code: 403

InternalServerErrorException

Deadline Cloud can't process your request right now. Try again later.

HTTP Status Code: 500

ResourceNotFoundException

The requested resource can't be found.

HTTP Status Code: 404

ThrottlingException

Your request exceeded a request rate quota.

HTTP Status Code: 429

ValidationException

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: