class Aws::PI::Types::GetResourceMetricsRequest
@note When making an API call, you may pass GetResourceMetricsRequest
data as a hash: { service_type: "RDS", # required, accepts RDS identifier: "RequestString", # required metric_queries: [ # required { metric: "RequestString", # required group_by: { group: "RequestString", # required dimensions: ["RequestString"], limit: 1, }, filter: { "RequestString" => "RequestString", }, }, ], start_time: Time.now, # required end_time: Time.now, # required period_in_seconds: 1, max_results: 1, next_token: "NextToken", }
@!attribute [rw] service_type
The AWS service for which Performance Insights returns metrics. The only valid value for *ServiceType* is `RDS`. @return [String]
@!attribute [rw] identifier
An immutable, AWS 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`. @return [String]
@!attribute [rw] metric_queries
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. @return [Array<Types::MetricQuery>]
@!attribute [rw] start_time
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`. @return [Time]
@!attribute [rw] end_time
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`. @return [Time]
@!attribute [rw] period_in_seconds
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. @return [Integer]
@!attribute [rw] max_results
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. @return [Integer]
@!attribute [rw] next_token
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`. @return [String]
@see docs.aws.amazon.com/goto/WebAPI/pi-2018-02-27/GetResourceMetricsRequest AWS API Documentation
Constants
- SENSITIVE