sessions_statistics_aggregations

Creates, updates, deletes, gets or lists a sessions_statistics_aggregations resource.

Overview

Name	sessions_statistics_aggregations
Type	Resource
Id	aws.deadline.sessions_statistics_aggregations

Fields

The following fields are returned by SELECT queries:

get_sessions_statistics_aggregation

Name	Datatype	Description
aggregation_end_time	string (date-time)	The end time for the aggregation.
aggregation_start_time	string (date-time)	The start time for the aggregation.
cost_in_usd	object	How the statistics should appear in USD. Options include: minimum, maximum, average or sum.
count	integer	The number of instances in a list of statistics.
fleet_id	string	The fleet ID. (pattern: <code>fleet-[0-9a-f]{32}</code>)
instance_type	string	The type of instance.
job_id	string	The job ID. (pattern: <code>job-[0-9a-f]{32}</code>)
job_name	string	The job name.
license_product	string	The licensed product.
queue_id	string	The queue ID. (pattern: <code>queue-[0-9a-f]{32}</code>)
runtime_in_seconds	object	The total aggregated runtime.
usage_type	string	The type of usage for the statistics. (COMPUTE, LICENSE, PERSISTENT_VOLUME)
user_id	string	The user ID.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_sessions_statistics_aggregation	select	farm_id, aggregationId, region	nextToken, maxResults	Gets a set of statistics for queues or farms. Before you can call the GetSessionStatisticsAggregation operation, you must first call the StartSessionsStatisticsAggregation operation. Statistics are available for 1 hour after you call the StartSessionsStatisticsAggregation operation.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
aggregationId	string	The identifier returned by the StartSessionsStatisticsAggregation operation that identifies the aggregated statistics.
farm_id	string	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.
region	string	AWS region (default: us-east-1)
maxResults	integer	The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
nextToken	string	The token for the next set of results, or null to start from the beginning.

SELECT examples

get_sessions_statistics_aggregation

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

SELECT
aggregation_end_time,
aggregation_start_time,
cost_in_usd,
count,
fleet_id,
instance_type,
job_id,
job_name,
license_product,
queue_id,
runtime_in_seconds,
usage_type,
user_id
FROM aws.deadline.sessions_statistics_aggregations
WHERE farm_id = '{{ farm_id }}' -- required
AND aggregationId = '{{ aggregationId }}' -- required
AND region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
;