Class: Aws::PI::Types::ListAvailableResourceMetricsRequest

Inherits:

Struct

• Object
• Struct
• Aws::PI::Types::ListAvailableResourceMetricsRequest

Includes:

Structure

Defined in:

lib/aws-sdk-pi/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #identifier ⇒ String

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

• #max_results ⇒ Integer

  The maximum number of items to return.

• #metric_types ⇒ Array<String>

  The types of metrics to return in the response.

• #next_token ⇒ String

  An optional pagination token provided by a previous request.

• #service_type ⇒ String

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

Instance Attribute Details

#identifier ⇒ String

An immutable identifier for a data source that is unique within an Amazon Web Services Region. Performance Insights gathers metrics from this data source. To use an Amazon RDS DB instance as a data source, specify its ‘DbiResourceId` value. For example, specify `db-ABCDEFGHIJKLMNOPQRSTU1VWZ`.

Returns:

• (String)

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

class ListAvailableResourceMetricsRequest < Struct.new(
  :service_type,
  :identifier,
  :metric_types,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#max_results ⇒ Integer

The maximum number of items to return. If the ‘MaxRecords` value is less than the number of existing items, the response includes a pagination token.

Returns:

• (Integer)

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

class ListAvailableResourceMetricsRequest < Struct.new(
  :service_type,
  :identifier,
  :metric_types,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#metric_types ⇒ Array<String>

The types of metrics to return in the response. Valid values in the array include the following:

• ‘os` (OS counter metrics) - All engines

• ‘db` (DB load metrics) - All engines except for Amazon DocumentDB

• ‘db.sql.stats` (per-SQL metrics) - All engines except for Amazon DocumentDB

• ‘db.sql_tokenized.stats` (per-SQL digest metrics) - All engines except for Amazon DocumentDB

Returns:

• (Array<String>)

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

class ListAvailableResourceMetricsRequest < Struct.new(
  :service_type,
  :identifier,
  :metric_types,
  :next_token,
  :max_results)
  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 'lib/aws-sdk-pi/types.rb', line 1304

class ListAvailableResourceMetricsRequest < Struct.new(
  :service_type,
  :identifier,
  :metric_types,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#service_type ⇒ String

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

Returns:

• (String)

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

class ListAvailableResourceMetricsRequest < Struct.new(
  :service_type,
  :identifier,
  :metric_types,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end