Class: Aws::PI::Types::GetResourceMetricsRequest

Inherits:

Struct

• Object
• Struct
• Aws::PI::Types::GetResourceMetricsRequest

Defined in:

gems/aws-sdk-pi/lib/aws-sdk-pi/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #end_time ⇒ Time

  The date and time specifying the end of the requested time series query range.

• #identifier ⇒ String

  An immutable identifier for a data source that is unique for an Amazon Web Services Region.

• #max_results ⇒ Integer

  The maximum number of items to return in the response.

• #metric_queries ⇒ Array<Types::MetricQuery>

  An array of one or more queries to perform.

• #next_token ⇒ String

  An optional pagination token provided by a previous request.

• #period_alignment ⇒ String

  The returned timestamp which is the start or end time of the time periods.

• #period_in_seconds ⇒ Integer

  The granularity, in seconds, of the data points returned from Performance Insights.

• #service_type ⇒ String

  The Amazon Web Services service for which Performance Insights returns metrics.

• #start_time ⇒ Time

  The date and time specifying the beginning of the requested time series query range.

Instance Attribute Details

#end_time ⇒ Time

The date and time specifying the end of the requested time series query range. The value specified is exclusive. Thus, the command returns data points less than (but not equal to) EndTime.

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

Returns:

• (Time)

# File 'gems/aws-sdk-pi/lib/aws-sdk-pi/types.rb', line 1024

class GetResourceMetricsRequest < Struct.new(
  :service_type,
  :identifier,
  :metric_queries,
  :start_time,
  :end_time,
  :period_in_seconds,
  :max_results,
  :next_token,
  :period_alignment)
  SENSITIVE = []
  include Aws::Structure
end

#identifier ⇒ String

An immutable identifier for a data source that is unique for an Amazon Web Services Region. Performance Insights gathers metrics from this data source. In the console, the identifier is shown as ResourceID. When you call DescribeDBInstances, the identifier is returned as DbiResourceId.

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

Returns:

• (String)

# File 'gems/aws-sdk-pi/lib/aws-sdk-pi/types.rb', line 1024

class GetResourceMetricsRequest < Struct.new(
  :service_type,
  :identifier,
  :metric_queries,
  :start_time,
  :end_time,
  :period_in_seconds,
  :max_results,
  :next_token,
  :period_alignment)
  SENSITIVE = []
  include Aws::Structure
end

#max_results ⇒ Integer

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.

Returns:

• (Integer)

# File 'gems/aws-sdk-pi/lib/aws-sdk-pi/types.rb', line 1024

class GetResourceMetricsRequest < Struct.new(
  :service_type,
  :identifier,
  :metric_queries,
  :start_time,
  :end_time,
  :period_in_seconds,
  :max_results,
  :next_token,
  :period_alignment)
  SENSITIVE = []
  include Aws::Structure
end

#metric_queries ⇒ Array<Types::MetricQuery>

An array of one or more queries to perform. Each query must specify a Performance Insights metric and specify an aggregate function, and you can provide filtering criteria. You must append the aggregate function to the metric. For example, to find the average for the metric db.load you must use db.load.avg. Valid values for aggregate functions include .avg, .min, .max, and .sum.

Returns:

• (Array<Types::MetricQuery>)

# File 'gems/aws-sdk-pi/lib/aws-sdk-pi/types.rb', line 1024

class GetResourceMetricsRequest < Struct.new(
  :service_type,
  :identifier,
  :metric_queries,
  :start_time,
  :end_time,
  :period_in_seconds,
  :max_results,
  :next_token,
  :period_alignment)
  SENSITIVE = []
  include Aws::Structure
end

#next_token ⇒ String

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.

Returns:

• (String)

# File 'gems/aws-sdk-pi/lib/aws-sdk-pi/types.rb', line 1024

class GetResourceMetricsRequest < Struct.new(
  :service_type,
  :identifier,
  :metric_queries,
  :start_time,
  :end_time,
  :period_in_seconds,
  :max_results,
  :next_token,
  :period_alignment)
  SENSITIVE = []
  include Aws::Structure
end

#period_alignment ⇒ String

The returned timestamp which is the start or end time of the time periods. The default value is END_TIME.

Returns:

• (String)

# File 'gems/aws-sdk-pi/lib/aws-sdk-pi/types.rb', line 1024

class GetResourceMetricsRequest < Struct.new(
  :service_type,
  :identifier,
  :metric_queries,
  :start_time,
  :end_time,
  :period_in_seconds,
  :max_results,
  :next_token,
  :period_alignment)
  SENSITIVE = []
  include Aws::Structure
end

#period_in_seconds ⇒ Integer

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.

Returns:

• (Integer)

# File 'gems/aws-sdk-pi/lib/aws-sdk-pi/types.rb', line 1024

class GetResourceMetricsRequest < Struct.new(
  :service_type,
  :identifier,
  :metric_queries,
  :start_time,
  :end_time,
  :period_in_seconds,
  :max_results,
  :next_token,
  :period_alignment)
  SENSITIVE = []
  include Aws::Structure
end

#service_type ⇒ String

The Amazon Web Services service for which Performance Insights returns metrics. Valid values are as follows:

• RDS

• DOCDB

Returns:

• (String)

# File 'gems/aws-sdk-pi/lib/aws-sdk-pi/types.rb', line 1024

class GetResourceMetricsRequest < Struct.new(
  :service_type,
  :identifier,
  :metric_queries,
  :start_time,
  :end_time,
  :period_in_seconds,
  :max_results,
  :next_token,
  :period_alignment)
  SENSITIVE = []
  include Aws::Structure
end

#start_time ⇒ Time

The date and time specifying the beginning of the requested time series query range. You can't specify a StartTime that is earlier than 7 days ago. By default, Performance Insights has 7 days of retention, but you can extend this range up to 2 years. The value specified is inclusive. Thus, the command returns data points equal to or greater than StartTime.

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

Returns:

• (Time)

# File 'gems/aws-sdk-pi/lib/aws-sdk-pi/types.rb', line 1024

class GetResourceMetricsRequest < Struct.new(
  :service_type,
  :identifier,
  :metric_queries,
  :start_time,
  :end_time,
  :period_in_seconds,
  :max_results,
  :next_token,
  :period_alignment)
  SENSITIVE = []
  include Aws::Structure
end