aws-sdk-pi 1.24.0 → 1.25.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8b6c000a6452ff602852b51970d5d036a57b50f928123b52cf2120807c79e986
-  data.tar.gz: 745708ba09a5e8d8ab8422ffb3735458701b6660ccf57341b384f8e88ddcdb11
+  metadata.gz: a945b3299f248a4de467e0235c9780c1ab428c4bf37cc45f1b6feb5ce18f6f64
+  data.tar.gz: 278b7bf031a88d17dbfd4ac15fd58c9c7e8eaae8c28b0c2e5f938fb7221bf46c
 SHA512:
-  metadata.gz: '071128cffc17d7e222470ec8eb7c4c9032571d446a22dac0b643fe7d8137947a7768132b57b616410dcf1207f2e0516d76fd4d93f0279dd3722f7ce4d53c3343'
-  data.tar.gz: e9433422fa8cd804ad973e2794800ef8827c8542cc7811b55841c5906649f01b3964f8d32ec79603e0f7627113e79a06451ab0f9eedb95974b80eb476c32e0b8
+  metadata.gz: '0399f4e5b882a6917fb57bfc48444eec243f895abff49a54e9a7a67d25c22cd3678789910cfbd96ed2b2e05df4ea82261a777d9abe11e3052ff8c57b59e2b530'
+  data.tar.gz: bb27d84a1481208ea3c8858c40754ea2c62fa10112d17c0df036f83f9da26bd4c5b7ebc2e21c4199bb207eecd6212c223997f9f19cec1742d5e391a3954e4a2b

data/lib/aws-sdk-pi.rb

@@ -48,6 +48,6 @@ require_relative 'aws-sdk-pi/customizations'
 # @!group service
 module Aws::PI
 
-  GEM_VERSION = '1.24.0'
+  GEM_VERSION = '1.25.0'
 
 end

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

@@ -340,30 +340,37 @@ module Aws::PI
     # For a specific time period, retrieve the top `N` dimension keys for a
     # metric.
     #
+    # <note markdown="1"> Each response element returns a maximum of 500 bytes. For larger
+    # elements, such as SQL statements, only the first 500 bytes are
+    # returned.
+    #
+    #  </note>
+    #
     # @option params [required, String] :service_type
     #   The AWS service for which Performance Insights will return metrics.
-    #   The only valid value for *ServiceType* is: `RDS`
+    #   The only valid value for *ServiceType* is `RDS`.
     #
     # @option params [required, String] :identifier
     #   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`
+    #   `DbiResourceId` value. For example, specify
+    #   `db-FAIHNTYBKTGAUSUZQYPDS2GW4A`
     #
     # @option params [required, Time,DateTime,Date,Integer,String] :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.
+    #   series data. You must specify a `StartTime` within the past 7 days.
+    #   The value specified is *inclusive*, which means that data points equal
+    #   to or greater than `StartTime` are returned.
     #
     #   The value for `StartTime` must be earlier than the value for
     #   `EndTime`.
     #
     # @option params [required, Time,DateTime,Date,Integer,String] :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.
+    #   data. The value specified is *exclusive*, which means that data points
+    #   less than (but not equal to) `EndTime` are returned.
     #
     #   The value for `EndTime` must be later than the value for `StartTime`.
     #
@@ -378,6 +385,14 @@ module Aws::PI
     #   * `db.sampledload.avg` - the raw number of active sessions for the
     #     database engine.
     #
+    #   If the number of active sessions is less than an internal Performance
+    #   Insights threshold, `db.load.avg` and `db.sampledload.avg` are the
+    #   same value. If the number of active sessions is greater than the
+    #   internal threshold, Performance Insights samples the active sessions,
+    #   with `db.load.avg` showing the scaled values, `db.sampledload.avg`
+    #   showing the raw values, and `db.sampledload.avg` less than
+    #   `db.load.avg`. For most use cases, you can query `db.load.avg` only.
+    #
     # @option params [Integer] :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
@@ -394,16 +409,16 @@ module Aws::PI
     #   * `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.
+    #   chooses a value for you, with a goal of returning roughly 100-200 data
+    #   points in the response.
     #
     # @option params [required, Types::DimensionGroup] :group_by
     #   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.
+    #   returns all dimensions within this group, unless you provide the names
+    #   of specific dimensions within this group. You can also request that
+    #   Performance Insights return a limited number of values for a
+    #   dimension.
     #
     # @option params [Types::DimensionGroup] :partition_by
     #   For each dimension specified in `GroupBy`, specify a secondary
@@ -491,16 +506,22 @@ module Aws::PI
     # dimensions, and provide aggregation and filtering criteria for each
     # group.
     #
+    # <note markdown="1"> Each response element returns a maximum of 500 bytes. For larger
+    # elements, such as SQL statements, only the first 500 bytes are
+    # returned.
+    #
+    #  </note>
+    #
     # @option params [required, String] :service_type
-    #   The AWS service for which Performance Insights will return metrics.
-    #   The only valid value for *ServiceType* is: `RDS`
+    #   The AWS service for which Performance Insights returns metrics. The
+    #   only valid value for *ServiceType* is `RDS`.
     #
     # @option params [required, String] :identifier
     #   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`
+    #   To use a DB instance as a data source, specify its `DbiResourceId`
+    #   value. For example, specify `db-FAIHNTYBKTGAUSUZQYPDS2GW4A`.
     #
     # @option params [required, Array<Types::MetricQuery>] :metric_queries
     #   An array of one or more queries to perform. Each query must specify a
@@ -517,7 +538,7 @@ module Aws::PI
     #   `EndTime`.
     #
     # @option params [required, Time,DateTime,Date,Integer,String] :end_time
-    #   The date and time specifiying the end of the requested time series
+    #   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.
     #
@@ -622,7 +643,7 @@ module Aws::PI
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-pi'
-      context[:gem_version] = '1.24.0'
+      context[:gem_version] = '1.25.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

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

@@ -59,7 +59,7 @@ module Aws::PI
     #
     # @!attribute [rw] service_type
     #   The AWS service for which Performance Insights will return metrics.
-    #   The only valid value for *ServiceType* is: `RDS`
+    #   The only valid value for *ServiceType* is `RDS`.
     #   @return [String]
     #
     # @!attribute [rw] identifier
@@ -67,14 +67,15 @@ module Aws::PI
     #   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`
+    #   `DbiResourceId` value. For example, specify
+    #   `db-FAIHNTYBKTGAUSUZQYPDS2GW4A`
     #   @return [String]
     #
     # @!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.
+    #   series data. You must specify a `StartTime` within the past 7 days.
+    #   The value specified is *inclusive*, which means that data points
+    #   equal to or greater than `StartTime` are returned.
     #
     #   The value for `StartTime` must be earlier than the value for
     #   `EndTime`.
@@ -82,8 +83,8 @@ module Aws::PI
     #
     # @!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.
+    #   data. The value specified is *exclusive*, which means that data
+    #   points less than (but not equal to) `EndTime` are returned.
     #
     #   The value for `EndTime` must be later than the value for
     #   `StartTime`.
@@ -99,6 +100,15 @@ module Aws::PI
     #
     #   * `db.sampledload.avg` - the raw number of active sessions for the
     #     database engine.
+    #
+    #   If the number of active sessions is less than an internal
+    #   Performance Insights threshold, `db.load.avg` and
+    #   `db.sampledload.avg` are the same value. If the number of active
+    #   sessions is greater than the internal threshold, Performance
+    #   Insights samples the active sessions, with `db.load.avg` showing the
+    #   scaled values, `db.sampledload.avg` showing the raw values, and
+    #   `db.sampledload.avg` less than `db.load.avg`. For most use cases,
+    #   you can query `db.load.avg` only.
     #   @return [String]
     #
     # @!attribute [rw] period_in_seconds
@@ -117,17 +127,17 @@ module Aws::PI
     #   * `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.
+    #   chooses a value for you, with a goal of returning roughly 100-200
+    #   data points in the response.
     #   @return [Integer]
     #
     # @!attribute [rw] group_by
     #   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.
+    #   Insights returns all dimensions within this group, unless you
+    #   provide the names of specific dimensions within this group. You can
+    #   also request that Performance Insights return a limited number of
+    #   values for a dimension.
     #   @return [Types::DimensionGroup]
     #
     # @!attribute [rw] partition_by
@@ -222,6 +232,12 @@ module Aws::PI
     # the following dimensions: `db.sql.id`, `db.sql.db_id`,
     # `db.sql.statement`, and `db.sql.tokenized_id`.
     #
+    # <note markdown="1"> Each response element returns a maximum of 500 bytes. For larger
+    # elements, such as SQL statements, only the first 500 bytes are
+    # returned.
+    #
+    #  </note>
+    #
     # @note When making an API call, you may pass DimensionGroup
     #   data as a hash:
     #
@@ -234,17 +250,29 @@ module Aws::PI
     # @!attribute [rw] group
     #   The name of the dimension group. Valid values are:
     #
-    #   * `db.user`
+    #   * `db` - The name of the database to which the client is connected
+    #     (only Aurora PostgreSQL, RDS PostgreSQL, Aurora MySQL, RDS MySQL,
+    #     and MariaDB)
+    #
+    #   * `db.application` - The name of the application that is connected
+    #     to the database (only Aurora PostgreSQL and RDS PostgreSQL)
+    #
+    #   * `db.host` - The host name of the connected client (all engines)
+    #
+    #   * `db.session_type` - The type of the current session (only Aurora
+    #     PostgreSQL and RDS PostgreSQL)
     #
-    #   * `db.host`
+    #   * `db.sql` - The SQL that is currently executing (all engines)
     #
-    #   * `db.sql`
+    #   * `db.sql_tokenized` - The SQL digest (all engines)
     #
-    #   * `db.sql_tokenized`
+    #   * `db.wait_event` - The event for which the database backend is
+    #     waiting (all engines)
     #
-    #   * `db.wait_event`
+    #   * `db.wait_event_type` - The type of event for which the database
+    #     backend is waiting (all engines)
     #
-    #   * `db.wait_event_type`
+    #   * `db.user` - The user logged in to the database (all engines)
     #   @return [String]
     #
     # @!attribute [rw] dimensions
@@ -255,33 +283,55 @@ module Aws::PI
     #
     #   Valid values for elements in the `Dimensions` array are:
     #
-    #   * db.user.id
+    #   * `db.application.name` - The name of the application that is
+    #     connected to the database (only Aurora PostgreSQL and RDS
+    #     PostgreSQL)
+    #
+    #   * `db.host.id` - The host ID of the connected client (all engines)
+    #
+    #   * `db.host.name` - The host name of the connected client (all
+    #     engines)
+    #
+    #   * `db.name` - The name of the database to which the client is
+    #     connected (only Aurora PostgreSQL, RDS PostgreSQL, Aurora MySQL,
+    #     RDS MySQL, and MariaDB)
     #
-    #   * db.user.name
+    #   * `db.session_type.name` - The type of the current session (only
+    #     Aurora PostgreSQL and RDS PostgreSQL)
     #
-    #   * db.host.id
+    #   * `db.sql.id` - The SQL ID generated by Performance Insights (all
+    #     engines)
     #
-    #   * db.host.name
+    #   * `db.sql.db_id` - The SQL ID generated by the database (all
+    #     engines)
     #
-    #   * db.sql.id
+    #   * `db.sql.statement` - The SQL text that is being executed (all
+    #     engines)
     #
-    #   * db.sql.db\_id
+    #   * `db.sql.tokenized_id`
     #
-    #   * db.sql.statement
+    #   * `db.sql_tokenized.id` - The SQL digest ID generated by Performance
+    #     Insights (all engines)
     #
-    #   * db.sql.tokenized\_id
+    #   * `db.sql_tokenized.db_id` - SQL digest ID generated by the database
+    #     (all engines)
     #
-    #   * db.sql\_tokenized.id
+    #   * `db.sql_tokenized.statement` - The SQL digest text (all engines)
     #
-    #   * db.sql\_tokenized.db\_id
+    #   * `db.user.id` - The ID of the user logged in to the database (all
+    #     engines)
     #
-    #   * db.sql\_tokenized.statement
+    #   * `db.user.name` - The name of the user logged in to the database
+    #     (all engines)
     #
-    #   * db.wait\_event.name
+    #   * `db.wait_event.name` - The event for which the backend is waiting
+    #     (all engines)
     #
-    #   * db.wait\_event.type
+    #   * `db.wait_event.type` - The type of event for which the backend is
+    #     waiting (all engines)
     #
-    #   * db.wait\_event\_type.name
+    #   * `db.wait_event_type.name` - The name of the event type for which
+    #     the backend is waiting (all engines)
     #   @return [Array<String>]
     #
     # @!attribute [rw] limit
@@ -352,16 +402,16 @@ module Aws::PI
     #       }
     #
     # @!attribute [rw] service_type
-    #   The AWS service for which Performance Insights will return metrics.
-    #   The only valid value for *ServiceType* is: `RDS`
+    #   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 an Amazon RDS instance as a data source, you specify its
-    #   `DbiResourceId` value - for example: `db-FAIHNTYBKTGAUSUZQYPDS2GW4A`
+    #   To use a DB instance as a data source, specify its `DbiResourceId`
+    #   value. For example, specify `db-FAIHNTYBKTGAUSUZQYPDS2GW4A`.
     #   @return [String]
     #
     # @!attribute [rw] metric_queries
@@ -381,7 +431,7 @@ module Aws::PI
     #   @return [Time]
     #
     # @!attribute [rw] end_time
-    #   The date and time specifiying the end of the requested time series
+    #   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.
     #
@@ -455,7 +505,7 @@ module Aws::PI
     #   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
+    #   To use a DB instance as a data source, you specify its
     #   `DbiResourceId` value - for example: `db-FAIHNTYBKTGAUSUZQYPDS2GW4A`
     #   @return [String]
     #
@@ -508,7 +558,7 @@ module Aws::PI
       include Aws::Structure
     end
 
-    # A time-ordered series of data points, correpsonding to a dimension of
+    # A time-ordered series of data points, corresponding to a dimension of
     # a Performance Insights metric.
     #
     # @!attribute [rw] key
@@ -560,6 +610,15 @@ module Aws::PI
     #
     #   * `db.sampledload.avg` - the raw number of active sessions for the
     #     database engine.
+    #
+    #   If the number of active sessions is less than an internal
+    #   Performance Insights threshold, `db.load.avg` and
+    #   `db.sampledload.avg` are the same value. If the number of active
+    #   sessions is greater than the internal threshold, Performance
+    #   Insights samples the active sessions, with `db.load.avg` showing the
+    #   scaled values, `db.sampledload.avg` showing the raw values, and
+    #   `db.sampledload.avg` less than `db.load.avg`. For most use cases,
+    #   you can query `db.load.avg` only.
     #   @return [String]
     #
     # @!attribute [rw] group_by
@@ -632,6 +691,15 @@ module Aws::PI
     #
     #   * `db.sampledload.avg` - the raw number of active sessions for the
     #     database engine.
+    #
+    #   If the number of active sessions is less than an internal
+    #   Performance Insights threshold, `db.load.avg` and
+    #   `db.sampledload.avg` are the same value. If the number of active
+    #   sessions is greater than the internal threshold, Performance
+    #   Insights samples the active sessions, with `db.load.avg` showing the
+    #   scaled values, `db.sampledload.avg` showing the raw values, and
+    #   `db.sampledload.avg` less than `db.load.avg`. For most use cases,
+    #   you can query `db.load.avg` only.
     #   @return [String]
     #
     # @!attribute [rw] dimensions

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-pi
 version: !ruby/object:Gem::Version
-  version: 1.24.0
+  version: 1.25.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-09-30 00:00:00.000000000 Z
+date: 2020-12-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core