aws-sdk-pi 1.38.0 → 1.39.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4416004eafc05fb5fc789b176493e9c2a5e9d9731449e574b4004634cd255d47
-  data.tar.gz: 2eb9e832146adee0784edccfa67460f8ba0922ecef7f8f38288a4a488d4d051b
+  metadata.gz: a0ac874fe2ab754adfc5aef8e56f2e08570e670d9cc500b0bc6c241530f13504
+  data.tar.gz: a1bb8ab560af041cca28bafff2fd6a85b7b1729365d7454182707633d82ec624
 SHA512:
-  metadata.gz: 74f1718a960b67323c1ee667864c4b53a44618028268bccb983da1226392147757dadbb4bcba140a7dfafc56fa138ffae21c077e5d2fa3ecca3eb415deb7a606
-  data.tar.gz: 03740cf2f8b61731d39bcf627d6d45b5d9a73eaa60ccfbb2c7a905a3e985ca9d00cfbc4c6376ded968ce10efc79f61b17d07fa57d856b8ee6f8933d190dc5af4
+  metadata.gz: 1fdf72f3c5689e019bfab3204b65c787789fb321dff2291abfb151cbdee3cdf6fc774c9fd29567cf247c34e0493a5f75c6a69bc747559daf1a59bea395fa8324
+  data.tar.gz: 9963d865a0c288db18b62cb2104a9e19cceedcc76b6d5038ffad29339a4caeb3f7eed40af9fcfc98e2943f6bab133f018ad4c40dab5c89655f710e833810cc6b

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Unreleased Changes
 ------------------
 
+1.39.0 (2022-04-07)
+------------------
+
+* Feature - Adds support for DocumentDB to the Performance Insights API.
+
 1.38.0 (2022-02-24)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.38.0
+1.39.0

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

@@ -372,7 +372,11 @@ module Aws::PI
     #
     # @option params [required, String] :service_type
     #   The Amazon Web Services service for which Performance Insights will
-    #   return metrics. The only valid value for *ServiceType* is `RDS`.
+    #   return metrics. Valid values are as follows:
+    #
+    #   * `RDS`
+    #
+    #   * `DOCDB`
     #
     # @option params [required, String] :identifier
     #   An immutable, Amazon Web Services Region-unique identifier for a data
@@ -403,10 +407,10 @@ module Aws::PI
     #
     #   Valid values for `Metric` are:
     #
-    #   * `db.load.avg` - a scaled representation of the number of active
+    #   * `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
+    #   * `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
@@ -448,8 +452,8 @@ module Aws::PI
     #   Additional metrics for the top `N` dimension keys. If the specified
     #   dimension group in the `GroupBy` parameter is `db.sql_tokenized`, you
     #   can specify per-SQL metrics to get the values for the top `N` SQL
-    #   digests. The response syntax is `"AdditionalMetrics" : \{ "string" :
-    #   "string" \}`.
+    #   digests. The response syntax is as follows: `"AdditionalMetrics" : \{
+    #   "string" : "string" \}`.
     #
     # @option params [Types::DimensionGroup] :partition_by
     #   For each dimension specified in `GroupBy`, specify a secondary
@@ -540,7 +544,7 @@ module Aws::PI
     # Get the attributes of the specified dimension group for a DB instance
     # or data source. For example, if you specify a SQL ID,
     # `GetDimensionKeyDetails` retrieves the full text of the dimension
-    # `db.sql.statement`cassociated with this ID. This operation is useful
+    # `db.sql.statement` associated with this ID. This operation is useful
     # because `GetResourceMetrics` and `DescribeDimensionKeys` don't
     # support retrieval of large SQL statement text.
     #
@@ -555,21 +559,35 @@ module Aws::PI
     #   value. For example, specify `db-ABCDEFGHIJKLMNOPQRSTU1VW2X`.
     #
     # @option params [required, String] :group
-    #   The name of the dimension group. The only valid value is `db.sql`.
-    #   Performance Insights searches the specified group for the dimension
-    #   group ID.
+    #   The name of the dimension group. Performance Insights searches the
+    #   specified group for the dimension group ID. The following group name
+    #   values are valid:
+    #
+    #   * `db.query` (Amazon DocumentDB only)
+    #
+    #   * `db.sql` (Amazon RDS and Aurora only)
     #
     # @option params [required, String] :group_identifier
     #   The ID of the dimension group from which to retrieve dimension
     #   details. For dimension group `db.sql`, the group ID is `db.sql.id`.
+    #   The following group ID values are valid:
+    #
+    #   * `db.sql.id` for dimension group `db.sql` (Aurora and RDS only)
+    #
+    #   * `db.query.id` for dimension group `db.query` (DocumentDB only)
     #
     # @option params [Array<String>] :requested_dimensions
     #   A list of dimensions to retrieve the detail data for within the given
-    #   dimension group. For the dimension group `db.sql`, specify either the
-    #   full dimension name `db.sql.statement` or the short dimension name
-    #   `statement`. If you don't specify this parameter, Performance
+    #   dimension group. If you don't specify this parameter, Performance
     #   Insights returns all dimension data within the specified dimension
-    #   group.
+    #   group. Specify dimension names for the following dimension groups:
+    #
+    #   * `db.sql` - Specify either the full dimension name `db.sql.statement`
+    #     or the short dimension name `statement` (Aurora and RDS only).
+    #
+    #   * `db.query` - Specify either the full dimension name
+    #     `db.query.statement` or the short dimension name `statement`
+    #     (DocumentDB only).
     #
     # @return [Types::GetDimensionKeyDetailsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
@@ -643,10 +661,9 @@ module Aws::PI
       req.send_request(options)
     end
 
-    # 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.
+    # 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.
     #
     # <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
@@ -656,14 +673,21 @@ module Aws::PI
     #
     # @option params [required, String] :service_type
     #   The Amazon Web Services service for which Performance Insights returns
-    #   metrics. The only valid value for *ServiceType* is `RDS`.
+    #   metrics. Valid values are as follows:
+    #
+    #   * `RDS`
+    #
+    #   * `DOCDB`
     #
     # @option params [required, String] :identifier
-    #   An immutable, Amazon Web Services Region-unique identifier for a data
-    #   source. Performance Insights gathers metrics from this data source.
+    #   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-FAIHNTYBKTGAUSUZQYPDS2GW4A`.
+    #   value. For example, specify `db-ABCDEFGHIJKLMNOPQRSTU1VW2X`.
     #
     # @option params [required, Array<Types::MetricQuery>] :metric_queries
     #   An array of one or more queries to perform. Each query must specify a
@@ -672,17 +696,19 @@ module Aws::PI
     #
     # @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 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`.
     #
     # @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.
+    #   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`.
     #
@@ -857,13 +883,15 @@ module Aws::PI
     #   The types of metrics to return in the response. Valid values in the
     #   array include the following:
     #
-    #   * `os` (OS counter metrics)
+    #   * `os` (OS counter metrics) - All engines
     #
-    #   * `db` (DB load metrics)
+    #   * `db` (DB load metrics) - All engines except for Amazon DocumentDB
     #
-    #   * `db.sql.stats` (per-SQL metrics)
+    #   * `db.sql.stats` (per-SQL metrics) - All engines except for Amazon
+    #     DocumentDB
     #
-    #   * `db.sql_tokenized.stats` (per-SQL digest metrics)
+    #   * `db.sql_tokenized.stats` (per-SQL digest metrics) - All engines
+    #     except for Amazon DocumentDB
     #
     # @option params [String] :next_token
     #   An optional pagination token provided by a previous request. If this
@@ -922,7 +950,7 @@ module Aws::PI
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-pi'
-      context[:gem_version] = '1.38.0'
+      context[:gem_version] = '1.39.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

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

@@ -60,7 +60,11 @@ module Aws::PI
     #
     # @!attribute [rw] service_type
     #   The Amazon Web Services service for which Performance Insights will
-    #   return metrics. The only valid value for *ServiceType* is `RDS`.
+    #   return metrics. Valid values are as follows:
+    #
+    #   * `RDS`
+    #
+    #   * `DOCDB`
     #   @return [String]
     #
     # @!attribute [rw] identifier
@@ -97,10 +101,10 @@ module Aws::PI
     #
     #   Valid values for `Metric` are:
     #
-    #   * `db.load.avg` - a scaled representation of the number of active
+    #   * `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
+    #   * `db.sampledload.avg` - The raw number of active sessions for the
     #     database engine.
     #
     #   If the number of active sessions is less than an internal
@@ -146,8 +150,8 @@ module Aws::PI
     #   Additional metrics for the top `N` dimension keys. If the specified
     #   dimension group in the `GroupBy` parameter is `db.sql_tokenized`,
     #   you can specify per-SQL metrics to get the values for the top `N`
-    #   SQL digests. The response syntax is `"AdditionalMetrics" : \{
-    #   "string" : "string" \}`.
+    #   SQL digests. The response syntax is as follows: `"AdditionalMetrics"
+    #   : \{ "string" : "string" \}`.
     #   @return [Array<String>]
     #
     # @!attribute [rw] partition_by
@@ -255,8 +259,19 @@ module Aws::PI
 
     # A logical grouping of Performance Insights metrics for a related
     # subject area. For example, the `db.sql` dimension group consists of
-    # the following dimensions: `db.sql.id`, `db.sql.db_id`,
-    # `db.sql.statement`, and `db.sql.tokenized_id`.
+    # the following dimensions:
+    #
+    # * `db.sql.id` - The hash of a running SQL statement, generated by
+    #   Performance Insights.
+    #
+    # * `db.sql.db_id` - Either the SQL ID generated by the database engine,
+    #   or a value generated by Performance Insights that begins with `pi-`.
+    #
+    # * `db.sql.statement` - The full text of the SQL statement that is
+    #   running, for example, `SELECT * FROM employees`.
+    #
+    # * `db.sql_tokenized.id` - The hash of the SQL digest generated by
+    #   Performance Insights.
     #
     # <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
@@ -274,31 +289,59 @@ module Aws::PI
     #       }
     #
     # @!attribute [rw] group
-    #   The name of the dimension group. Valid values are:
+    #   The name of the dimension group. Valid values are as follows:
+    #
+    #   * `db` - The name of the database to which the client is connected.
+    #     The following values are permitted:
+    #
+    #     * Aurora PostgreSQL
+    #
+    #     * Amazon RDS PostgreSQL
     #
-    #   * `db` - The name of the database to which the client is connected
-    #     (only Aurora PostgreSQL, Amazon RDS PostgreSQL, Aurora MySQL,
-    #     Amazon RDS MySQL, and MariaDB)
+    #     * Aurora MySQL
+    #
+    #     * Amazon RDS MySQL
+    #
+    #     * Amazon RDS MariaDB
+    #
+    #     * Amazon DocumentDB
     #
     #   * `db.application` - The name of the application that is connected
-    #     to the database (only Aurora PostgreSQL and RDS PostgreSQL)
+    #     to the database. The following values are permitted:
+    #
+    #     * Aurora PostgreSQL
+    #
+    #     * Amazon RDS PostgreSQL
+    #
+    #     * Amazon DocumentDB
+    #
+    #   * `db.host` - The host name of the connected client (all engines).
+    #
+    #   * `db.query` - The query that is currently running (only Amazon
+    #     DocumentDB).
     #
-    #   * `db.host` - The host name of the connected client (all engines)
+    #   * `db.query_tokenized` - The digest query (only Amazon DocumentDB).
     #
     #   * `db.session_type` - The type of the current session (only Aurora
-    #     PostgreSQL and RDS PostgreSQL)
+    #     PostgreSQL and RDS PostgreSQL).
     #
-    #   * `db.sql` - The SQL that is currently executing (all engines)
+    #   * `db.sql` - The text of the SQL statement that is currently running
+    #     (all engines except Amazon DocumentDB).
     #
-    #   * `db.sql_tokenized` - The SQL digest (all engines)
+    #   * `db.sql_tokenized` - The SQL digest (all engines except Amazon
+    #     DocumentDB).
+    #
+    #   * `db.user` - The user logged in to the database (all engines except
+    #     Amazon DocumentDB).
     #
     #   * `db.wait_event` - The event for which the database backend is
-    #     waiting (all engines)
+    #     waiting (all engines except Amazon DocumentDB).
     #
     #   * `db.wait_event_type` - The type of event for which the database
-    #     backend is waiting (all engines)
+    #     backend is waiting (all engines except Amazon DocumentDB).
     #
-    #   * `db.user` - The user logged in to the database (all engines)
+    #   * `db.wait_state` - The event for which the database backend is
+    #     waiting (only Amazon DocumentDB).
     #   @return [String]
     #
     # @!attribute [rw] dimensions
@@ -310,54 +353,104 @@ module Aws::PI
     #   Valid values for elements in the `Dimensions` array are:
     #
     #   * `db.application.name` - The name of the application that is
-    #     connected to the database (only Aurora PostgreSQL and RDS
-    #     PostgreSQL)
+    #     connected to the database. Valid values are as follows:
+    #
+    #     * Aurora PostgreSQL
+    #
+    #     * Amazon RDS PostgreSQL
+    #
+    #     * Amazon DocumentDB
     #
-    #   * `db.host.id` - The host ID of the connected client (all engines)
+    #   * `db.host.id` - The host ID of the connected client (all engines).
     #
     #   * `db.host.name` - The host name of the connected client (all
-    #     engines)
+    #     engines).
     #
     #   * `db.name` - The name of the database to which the client is
-    #     connected (only Aurora PostgreSQL, Amazon RDS PostgreSQL, Aurora
-    #     MySQL, Amazon RDS MySQL, and MariaDB)
+    #     connected. Valid values are as follows:
+    #
+    #     * Aurora PostgreSQL
+    #
+    #     * Amazon RDS PostgreSQL
+    #
+    #     * Aurora MySQL
+    #
+    #     * Amazon RDS MySQL
+    #
+    #     * Amazon RDS MariaDB
+    #
+    #     * Amazon DocumentDB
+    #
+    #   * `db.query.id` - The query ID generated by Performance Insights
+    #     (only Amazon DocumentDB).
+    #
+    #   * `db.query.db_id` - The query ID generated by the database (only
+    #     Amazon DocumentDB).
+    #
+    #   * `db.query.statement` - The text of the query that is being run
+    #     (only Amazon DocumentDB).
+    #
+    #   * `db.query.tokenized_id`
+    #
+    #   * `db.query.tokenized.id` - The query digest ID generated by
+    #     Performance Insights (only Amazon DocumentDB).
+    #
+    #   * `db.query.tokenized.db_id` - The query digest ID generated by
+    #     Performance Insights (only Amazon DocumentDB).
+    #
+    #   * `db.query.tokenized.statement` - The text of the query digest
+    #     (only Amazon DocumentDB).
     #
     #   * `db.session_type.name` - The type of the current session (only
-    #     Aurora PostgreSQL and RDS PostgreSQL)
+    #     Amazon DocumentDB).
     #
-    #   * `db.sql.id` - The SQL ID generated by Performance Insights (all
-    #     engines)
+    #   * `db.sql.id` - The hash of the full, non-tokenized SQL statement
+    #     generated by Performance Insights (all engines except Amazon
+    #     DocumentDB).
     #
-    #   * `db.sql.db_id` - The SQL ID generated by the database (all
-    #     engines)
+    #   * `db.sql.db_id` - Either the SQL ID generated by the database
+    #     engine, or a value generated by Performance Insights that begins
+    #     with `pi-` (all engines except Amazon DocumentDB).
     #
-    #   * `db.sql.statement` - The SQL text that is being executed (all
-    #     engines)
+    #   * `db.sql.statement` - The full text of the SQL statement that is
+    #     running, as in `SELECT * FROM employees` (all engines except
+    #     Amazon DocumentDB)
     #
     #   * `db.sql.tokenized_id`
     #
-    #   * `db.sql_tokenized.id` - The SQL digest ID generated by Performance
-    #     Insights (all engines)
+    #   * `db.sql_tokenized.id` - The hash of the SQL digest generated by
+    #     Performance Insights (all engines except Amazon DocumentDB). In
+    #     the console, `db.sql_tokenized.id` is called the Support ID
+    #     because Amazon Web Services Support can look at this data to help
+    #     you troubleshoot database issues.
     #
-    #   * `db.sql_tokenized.db_id` - SQL digest ID generated by the database
-    #     (all engines)
+    #   * `db.sql_tokenized.db_id` - Either the native database ID used to
+    #     refer to the SQL statement, or a synthetic ID such as
+    #     `pi-2372568224` that Performance Insights generates if the native
+    #     database ID isn't available (all engines except Amazon
+    #     DocumentDB).
     #
-    #   * `db.sql_tokenized.statement` - The SQL digest text (all engines)
+    #   * `db.sql_tokenized.statement` - The text of the SQL digest, as in
+    #     `SELECT * FROM employees WHERE employee_id = ?` (all engines
+    #     except Amazon DocumentDB)
     #
     #   * `db.user.id` - The ID of the user logged in to the database (all
-    #     engines)
+    #     engines except Amazon DocumentDB).
     #
     #   * `db.user.name` - The name of the user logged in to the database
-    #     (all engines)
+    #     (all engines except Amazon DocumentDB).
     #
     #   * `db.wait_event.name` - The event for which the backend is waiting
-    #     (all engines)
+    #     (all engines except Amazon DocumentDB).
     #
     #   * `db.wait_event.type` - The type of event for which the backend is
-    #     waiting (all engines)
+    #     waiting (all engines except Amazon DocumentDB).
     #
     #   * `db.wait_event_type.name` - The name of the event type for which
-    #     the backend is waiting (all engines)
+    #     the backend is waiting (all engines except Amazon DocumentDB).
+    #
+    #   * `db.wait_state.name` - The event for which the backend is waiting
+    #     (only Amazon DocumentDB).
     #   @return [Array<String>]
     #
     # @!attribute [rw] limit
@@ -428,14 +521,22 @@ module Aws::PI
     # An object that describes the details for a specified dimension.
     #
     # @!attribute [rw] value
-    #   The value of the dimension detail data. For the `db.sql.statement`
-    #   dimension, this value is either the full or truncated SQL query,
-    #   depending on the return status.
+    #   The value of the dimension detail data. Depending on the return
+    #   status, this value is either the full or truncated SQL query for the
+    #   following dimensions:
+    #
+    #   * `db.query.statement` (Amazon DocumentDB)
+    #
+    #   * `db.sql.statement` (Amazon RDS and Aurora)
     #   @return [String]
     #
     # @!attribute [rw] dimension
     #   The full name of the dimension. The full name includes the group
-    #   name and key name. The only valid value is `db.sql.statement`.
+    #   name and key name. The following values are valid:
+    #
+    #   * `db.query.statement` (Amazon DocumentDB)
+    #
+    #   * `db.sql.statement` (Amazon RDS and Aurora)
     #   @return [String]
     #
     # @!attribute [rw] status
@@ -446,8 +547,8 @@ module Aws::PI
     #
     #   * `PROCESSING` - The dimension detail data isn't ready to be
     #     retrieved because more processing time is required. If the
-    #     requested detail data for `db.sql.statement` has the status
-    #     `PROCESSING`, Performance Insights returns the truncated query.
+    #     requested detail data has the status `PROCESSING`, Performance
+    #     Insights returns the truncated query.
     #
     #   * `UNAVAILABLE` - The dimension detail data could not be collected
     #     successfully.
@@ -470,19 +571,19 @@ module Aws::PI
     #   The status of the feature on the DB instance. Possible values
     #   include the following:
     #
-    #   * `ENABLED`\: the feature is enabled on the instance.
+    #   * `ENABLED` - The feature is enabled on the instance.
     #
-    #   * `DISABLED`\: the feature is disabled on the instance.
+    #   * `DISABLED` - The feature is disabled on the instance.
     #
-    #   * `UNSUPPORTED`\: the feature isn't supported on the instance.
+    #   * `UNSUPPORTED` - The feature isn't supported on the instance.
     #
-    #   * `ENABLED_PENDING_REBOOT`\: the feature is enabled on the instance
+    #   * `ENABLED_PENDING_REBOOT` - The feature is enabled on the instance
     #     but requires a reboot to take effect.
     #
-    #   * `DISABLED_PENDING_REBOOT`\: the feature is disabled on the
+    #   * `DISABLED_PENDING_REBOOT` - The feature is disabled on the
     #     instance but requires a reboot to take effect.
     #
-    #   * `UNKNOWN`\: the feature status couldn't be determined.
+    #   * `UNKNOWN` - The feature status couldn't be determined.
     #   @return [String]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/pi-2018-02-27/FeatureMetadata AWS API Documentation
@@ -518,23 +619,39 @@ module Aws::PI
     #   @return [String]
     #
     # @!attribute [rw] group
-    #   The name of the dimension group. The only valid value is `db.sql`.
-    #   Performance Insights searches the specified group for the dimension
-    #   group ID.
+    #   The name of the dimension group. Performance Insights searches the
+    #   specified group for the dimension group ID. The following group name
+    #   values are valid:
+    #
+    #   * `db.query` (Amazon DocumentDB only)
+    #
+    #   * `db.sql` (Amazon RDS and Aurora only)
     #   @return [String]
     #
     # @!attribute [rw] group_identifier
     #   The ID of the dimension group from which to retrieve dimension
     #   details. For dimension group `db.sql`, the group ID is `db.sql.id`.
+    #   The following group ID values are valid:
+    #
+    #   * `db.sql.id` for dimension group `db.sql` (Aurora and RDS only)
+    #
+    #   * `db.query.id` for dimension group `db.query` (DocumentDB only)
     #   @return [String]
     #
     # @!attribute [rw] requested_dimensions
     #   A list of dimensions to retrieve the detail data for within the
-    #   given dimension group. For the dimension group `db.sql`, specify
-    #   either the full dimension name `db.sql.statement` or the short
-    #   dimension name `statement`. If you don't specify this parameter,
+    #   given dimension group. If you don't specify this parameter,
     #   Performance Insights returns all dimension data within the specified
-    #   dimension group.
+    #   dimension group. Specify dimension names for the following dimension
+    #   groups:
+    #
+    #   * `db.sql` - Specify either the full dimension name
+    #     `db.sql.statement` or the short dimension name `statement` (Aurora
+    #     and RDS only).
+    #
+    #   * `db.query` - Specify either the full dimension name
+    #     `db.query.statement` or the short dimension name `statement`
+    #     (DocumentDB only).
     #   @return [Array<String>]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/pi-2018-02-27/GetDimensionKeyDetailsRequest AWS API Documentation
@@ -642,16 +759,22 @@ module Aws::PI
     #
     # @!attribute [rw] service_type
     #   The Amazon Web Services service for which Performance Insights
-    #   returns metrics. The only valid value for *ServiceType* is `RDS`.
+    #   returns metrics. Valid values are as follows:
+    #
+    #   * `RDS`
+    #
+    #   * `DOCDB`
     #   @return [String]
     #
     # @!attribute [rw] identifier
-    #   An immutable, Amazon Web Services Region-unique identifier for a
-    #   data source. Performance Insights gathers metrics from this data
-    #   source.
+    #   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-FAIHNTYBKTGAUSUZQYPDS2GW4A`.
+    #   value. For example, specify `db-ABCDEFGHIJKLMNOPQRSTU1VW2X`.
     #   @return [String]
     #
     # @!attribute [rw] metric_queries
@@ -662,9 +785,11 @@ module Aws::PI
     #
     # @!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 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`.
@@ -672,8 +797,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.
+    #   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`.
@@ -742,17 +867,16 @@ module Aws::PI
     #   @return [Time]
     #
     # @!attribute [rw] identifier
-    #   An immutable, Amazon Web Services Region-unique identifier for a
-    #   data source. Performance Insights gathers metrics from this data
-    #   source.
-    #
-    #   To use a DB instance as a data source, you specify its
-    #   `DbiResourceId` value - for example: `db-FAIHNTYBKTGAUSUZQYPDS2GW4A`
+    #   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`.
     #   @return [String]
     #
     # @!attribute [rw] metric_list
-    #   An array of metric results,, where each array element contains all
-    #   of the data points for a particular dimension.
+    #   An array of metric results, where each array element contains all of
+    #   the data points for a particular dimension.
     #   @return [Array<Types::MetricKeyDataPoints>]
     #
     # @!attribute [rw] next_token
@@ -900,13 +1024,15 @@ module Aws::PI
     #   The types of metrics to return in the response. Valid values in the
     #   array include the following:
     #
-    #   * `os` (OS counter metrics)
+    #   * `os` (OS counter metrics) - All engines
     #
-    #   * `db` (DB load metrics)
+    #   * `db` (DB load metrics) - All engines except for Amazon DocumentDB
     #
-    #   * `db.sql.stats` (per-SQL metrics)
+    #   * `db.sql.stats` (per-SQL metrics) - All engines except for Amazon
+    #     DocumentDB
     #
-    #   * `db.sql_tokenized.stats` (per-SQL digest metrics)
+    #   * `db.sql_tokenized.stats` (per-SQL digest metrics) - All engines
+    #     except for Amazon DocumentDB
     #   @return [Array<String>]
     #
     # @!attribute [rw] next_token
@@ -1020,12 +1146,15 @@ module Aws::PI
     #
     #   Valid values for `Metric` are:
     #
-    #   * `db.load.avg` - a scaled representation of the number of active
+    #   * `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
+    #   * `db.sampledload.avg` - The raw number of active sessions for the
     #     database engine.
     #
+    #   * The counter metrics listed in [Performance Insights operating
+    #     system counters][1] in the *Amazon Aurora User Guide*.
+    #
     #   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
@@ -1034,6 +1163,10 @@ module Aws::PI
     #   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.
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_PerfInsights_Counters.html#USER_PerfInsights_Counters.OS
     #   @return [String]
     #
     # @!attribute [rw] group_by
@@ -1126,12 +1259,15 @@ module Aws::PI
     #
     #   Valid values for `Metric` are:
     #
-    #   * `db.load.avg` - a scaled representation of the number of active
+    #   * `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
+    #   * `db.sampledload.avg` - The raw number of active sessions for the
     #     database engine.
     #
+    #   * The counter metrics listed in [Performance Insights operating
+    #     system counters][1] in the *Amazon Aurora User Guide*.
+    #
     #   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
@@ -1140,6 +1276,10 @@ module Aws::PI
     #   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.
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_PerfInsights_Counters.html#USER_PerfInsights_Counters.OS
     #   @return [String]
     #
     # @!attribute [rw] dimensions

data/lib/aws-sdk-pi.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-pi
 version: !ruby/object:Gem::Version
-  version: 1.38.0
+  version: 1.39.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-02-24 00:00:00.000000000 Z
+date: 2022-04-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core