You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::PI::Client

Inherits:

Seahorse::Client::Base

• Object
• Seahorse::Client::Base
• Aws::PI::Client

Includes:

ClientStubs

Defined in:

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

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

API Operations

• #describe_dimension_keys(params = {}) ⇒ Types::DescribeDimensionKeysResponse

  For a specific time period, retrieve the top N dimension keys for a metric.

• #get_resource_metrics(params = {}) ⇒ Types::GetResourceMetricsResponse

  Retrieve Performance Insights metrics for a set of data sources, over a time period.

Instance Method Summary

• #initialize(*args) ⇒ Client constructor

  A new instance of Client.

Methods included from ClientStubs

#api_requests, #stub_data, #stub_responses

Methods inherited from Seahorse::Client::Base

add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

#initialize(*args) ⇒ Client

Returns a new instance of Client

Parameters:

• options (Hash) —

  a customizable set of options

# File 'gems/aws-sdk-pi/lib/aws-sdk-pi/client.rb', line 183

def initialize(*args)
  super
end

Instance Method Details

#describe_dimension_keys(params = {}) ⇒ Types::DescribeDimensionKeysResponse

For a specific time period, retrieve the top N dimension keys for a metric.

Examples:

Request syntax with placeholder values

resp = client.describe_dimension_keys({
  service_type: "RDS", # required, accepts RDS
  identifier: "String", # required
  start_time: Time.now, # required
  end_time: Time.now, # required
  metric: "String", # required
  period_in_seconds: 1,
  group_by: { # required
    group: "String", # required
    dimensions: ["String"],
    limit: 1,
  },
  partition_by: {
    group: "String", # required
    dimensions: ["String"],
    limit: 1,
  },
  filter: {
    "String" => "String",
  },
  max_results: 1,
  next_token: "String",
})

Response structure

resp.aligned_start_time #=> Time
resp.aligned_end_time #=> Time
resp.partition_keys #=> Array
resp.partition_keys[0].dimensions #=> Hash
resp.partition_keys[0].dimensions["String"] #=> String
resp.keys #=> Array
resp.keys[0].dimensions #=> Hash
resp.keys[0].dimensions["String"] #=> String
resp.keys[0].total #=> Float
resp.keys[0].partitions #=> Array
resp.keys[0].partitions[0] #=> Float
resp.next_token #=> String

Parameters:

• params (Hash) (defaults to: {}) —

  ({})

Options Hash (params):

• :service_type (required, String) —

  The AWS service for which Performance Insights will return metrics. The only valid value for ServiceType is: RDS

• :identifier (required, String) —

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

  To use an Amazon RDS instance as a data source, you specify its DbiResourceId value - for example: db-FAIHNTYBKTGAUSUZQYPDS2GW4A

• :start_time (required, Time, DateTime, Date, Integer, String) —

  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.

• :end_time (required, Time, DateTime, Date, Integer, String) —

  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.

• :metric (required, String) —

  The name of a Performance Insights metric to be measured.

  Valid values for Metric are:

  • db.load.avg - a scaled representation of the number of active sessions for the database engine.

  • db.sampledload.avg - the raw number of active sessions for the database engine.

• :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.

• :group_by (required, Types::DimensionGroup) —

  A specification for how to aggregate the data points from a query result. You must specify a valid dimension group. Performance Insights will return all of the dimensions within that group, unless you provide the names of specific dimensions within that group. You can also request that Performance Insights return a limited number of values for a dimension.

• :partition_by (Types::DimensionGroup) —

  For each dimension specified in GroupBy, specify a secondary dimension to further subdivide the partition keys in the response.

• :filter (Hash<String,String>) —

  One or more filters to apply in the request. Restrictions:

  • Any number of filters by the same dimension, as specified in the GroupBy or Partition parameters.

  • A single filter for any other dimension in this dimension group.

• :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.

• :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:

• (Types::DescribeDimensionKeysResponse) —

  Returns a response object which responds to the following methods:

  • #aligned_start_time => Time
  • #aligned_end_time => Time
  • #partition_keys => Array<Types::ResponsePartitionKey>
  • #keys => Array<Types::DimensionKeyDescription>
  • #next_token => String

See Also:

• AWS API Documentation

# File 'gems/aws-sdk-pi/lib/aws-sdk-pi/client.rb', line 333

def describe_dimension_keys(params = {}, options = {})
  req = build_request(:describe_dimension_keys, params)
  req.send_request(options)
end

#get_resource_metrics(params = {}) ⇒ Types::GetResourceMetricsResponse

Retrieve Performance Insights metrics for a set of data sources, over a time period. You can provide specific dimension groups and dimensions, and provide aggregation and filtering criteria for each group.

Examples:

Request syntax with placeholder values

resp = client.get_resource_metrics({
  service_type: "RDS", # required, accepts RDS
  identifier: "String", # required
  metric_queries: [ # required
    {
      metric: "String", # required
      group_by: {
        group: "String", # required
        dimensions: ["String"],
        limit: 1,
      },
      filter: {
        "String" => "String",
      },
    },
  ],
  start_time: Time.now, # required
  end_time: Time.now, # required
  period_in_seconds: 1,
  max_results: 1,
  next_token: "String",
})

Response structure

resp.aligned_start_time #=> Time
resp.aligned_end_time #=> Time
resp.identifier #=> String
resp.metric_list #=> Array
resp.metric_list[0].key.metric #=> String
resp.metric_list[0].key.dimensions #=> Hash
resp.metric_list[0].key.dimensions["String"] #=> String
resp.metric_list[0].data_points #=> Array
resp.metric_list[0].data_points[0].timestamp #=> Time
resp.metric_list[0].data_points[0].value #=> Float
resp.next_token #=> String

Parameters:

• params (Hash) (defaults to: {}) —

  ({})

Options Hash (params):

• :service_type (required, String) —

  The AWS service for which Performance Insights will return metrics. The only valid value for ServiceType is: RDS

• :identifier (required, String) —

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

  To use an Amazon RDS instance as a data source, you specify its DbiResourceId value - for example: db-FAIHNTYBKTGAUSUZQYPDS2GW4A

• :metric_queries (required, Array<Types::MetricQuery>) —

  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.

• :start_time (required, Time, DateTime, Date, Integer, String) —

  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.

• :end_time (required, Time, DateTime, Date, Integer, String) —

  The date and time specifiying 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.

• :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.

• :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.

• :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:

• (Types::GetResourceMetricsResponse) —

  Returns a response object which responds to the following methods:

  • #aligned_start_time => Time
  • #aligned_end_time => Time
  • #identifier => String
  • #metric_list => Array<Types::MetricKeyDataPoints>
  • #next_token => String

See Also:

• AWS API Documentation

# File 'gems/aws-sdk-pi/lib/aws-sdk-pi/client.rb', line 456

def get_resource_metrics(params = {}, options = {})
  req = build_request(:get_resource_metrics, params)
  req.send_request(options)
end