GetResourceMetricsRequest

import type { GetResourceMetricsRequest } from "https://aws-api.deno.dev/v0.3/services/pi.ts?docs=full";

interface GetResourceMetricsRequest {

EndTime: Date | number;

Identifier: string;

MaxResults?: number | null;

MetricQueries: MetricQuery[];

NextToken?: string | null;

PeriodInSeconds?: number | null;

ServiceType: ServiceType;

StartTime: Date | number;

}

§Properties

EndTime: Date | number

[src]

The date and time specifying the end of the requested time series data. The value specified is exclusive - data points less than (but not equal to) EndTime will be returned.

The value for EndTime must be later than the value for StartTime.

Identifier: string

[src]

An immutable, Amazon Web Services Region-unique identifier for a data source. Performance Insights gathers metrics from this data source.

To use a DB instance as a data source, specify its DbiResourceId value. For example, specify db-FAIHNTYBKTGAUSUZQYPDS2GW4A.

MaxResults?: number | null

[src]

The maximum number of items to return in the response. If more items exist than the specified MaxRecords value, a pagination token is included in the response so that the remaining results can be retrieved.

MetricQueries: MetricQuery[]

[src]

An array of one or more queries to perform. Each query must specify a Performance Insights metric, and can optionally specify aggregation and filtering criteria.

NextToken?: string | null

[src]

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the token, up to the value specified by MaxRecords.

PeriodInSeconds?: number | null

[src]

The granularity, in seconds, of the data points returned from Performance Insights. A period can be as short as one second, or as long as one day (86400 seconds). Valid values are:

1 (one second)
60 (one minute)
300 (five minutes)
3600 (one hour)
86400 (twenty-four hours)

If you don't specify PeriodInSeconds, then Performance Insights will choose a value for you, with a goal of returning roughly 100-200 data points in the response.

ServiceType: ServiceType

[src]

The Amazon Web Services service for which Performance Insights returns metrics. The only valid value for ServiceType is RDS.

StartTime: Date | number

[src]

The date and time specifying the beginning of the requested time series data. You can't specify a StartTime that's earlier than 7 days ago. The value specified is inclusive - data points equal to or greater than StartTime will be returned.

The value for StartTime must be earlier than the value for EndTime.