[ aws . xray ]

get-time-series-service-statistics

Description

Get an aggregation of service statistics defined by a specific time range.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

get-time-series-service-statistics is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument. When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: TimeSeriesServiceStatistics

Synopsis

  get-time-series-service-statistics
--start-time <value>
--end-time <value>
[--group-name <value>]
[--group-arn <value>]
[--entity-selector-expression <value>]
[--period <value>]
[--forecast-statistics | --no-forecast-statistics]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]

Options

--start-time (timestamp)

The start of the time frame for which to aggregate statistics.

--end-time (timestamp)

The end of the time frame for which to aggregate statistics.

--group-name (string)

The case-sensitive name of the group for which to pull statistics from.

--group-arn (string)

The Amazon Resource Name (ARN) of the group for which to pull statistics from.

--entity-selector-expression (string)

A filter expression defining entities that will be aggregated for statistics. Supports ID, service, and edge functions. If no selector expression is specified, edge statistics are returned.

--period (integer)

Aggregation period in seconds.

--forecast-statistics | --no-forecast-statistics (boolean)

The forecasted high and low fault count values. Forecast enabled requests require the EntitySelectorExpression ID be provided.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

Output

TimeSeriesServiceStatistics -> (list)

The collection of statistics.

(structure)

A list of TimeSeriesStatistic structures.

Timestamp -> (timestamp)

Timestamp of the window for which statistics are aggregated.

EdgeSummaryStatistics -> (structure)

Response statistics for an edge.

OkCount -> (long)

The number of requests that completed with a 2xx Success status code.

ErrorStatistics -> (structure)

Information about requests that failed with a 4xx Client Error status code.

ThrottleCount -> (long)

The number of requests that failed with a 419 throttling status code.

OtherCount -> (long)

The number of requests that failed with untracked 4xx Client Error status codes.

TotalCount -> (long)

The total number of requests that failed with a 4xx Client Error status code.

FaultStatistics -> (structure)

Information about requests that failed with a 5xx Server Error status code.

OtherCount -> (long)

The number of requests that failed with untracked 5xx Server Error status codes.

TotalCount -> (long)

The total number of requests that failed with a 5xx Server Error status code.

TotalCount -> (long)

The total number of completed requests.

TotalResponseTime -> (double)

The aggregate response time of completed requests.

ServiceSummaryStatistics -> (structure)

Response statistics for a service.

OkCount -> (long)

The number of requests that completed with a 2xx Success status code.

ErrorStatistics -> (structure)

Information about requests that failed with a 4xx Client Error status code.

ThrottleCount -> (long)

The number of requests that failed with a 419 throttling status code.

OtherCount -> (long)

The number of requests that failed with untracked 4xx Client Error status codes.

TotalCount -> (long)

The total number of requests that failed with a 4xx Client Error status code.

FaultStatistics -> (structure)

Information about requests that failed with a 5xx Server Error status code.

OtherCount -> (long)

The number of requests that failed with untracked 5xx Server Error status codes.

TotalCount -> (long)

The total number of requests that failed with a 5xx Server Error status code.

TotalCount -> (long)

The total number of completed requests.

TotalResponseTime -> (double)

The aggregate response time of completed requests.

ServiceForecastStatistics -> (structure)

The forecasted high and low fault count values.

FaultCountHigh -> (long)

The upper limit of fault counts for a service.

FaultCountLow -> (long)

The lower limit of fault counts for a service.

ResponseTimeHistogram -> (list)

The response time histogram for the selected entities.

(structure)

An entry in a histogram for a statistic. A histogram maps the range of observed values on the X axis, and the prevalence of each value on the Y axis.

Value -> (double)

The value of the entry.

Count -> (integer)

The prevalence of the entry.

ContainsOldGroupVersions -> (boolean)

A flag indicating whether or not a group’s filter expression has been consistent, or if a returned aggregation might show statistics from an older version of the group’s filter expression.

NextToken -> (string)

Pagination token.