aws-sdk-pi 1.37.0 → 1.40.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 5224d1880c1244150f804309885e31a6d570cdbc35a88ac126ce115b5fcfe102
4
- data.tar.gz: c05dc07afad0f9239f3f606a2135e5a7e90a69ba1111e6dbefd8548f0cea29b9
3
+ metadata.gz: fdea6c0c3533ed373bebf8e627ea2a265ace1dd05eddc684f42ff22906ee4527
4
+ data.tar.gz: df48cffcdf60d8527220a986b5a5448e05b87b54291422aa82f2a6b83b7dcdbf
5
5
  SHA512:
6
- metadata.gz: 0d73327d6454d9e0288426f1b9595dc2aa71876a351f9be7a4e76876b1eb893df18d25747ca08809b8f0df3194a9a2d870352925983833369d8261a8cce9757f
7
- data.tar.gz: 7e24f5b28d19d279b22c96f42916b5ce611c1caaeefe23dfa8de6b062b25515cb593895188101f28ac6faf984fa07a19f8f9c94d369053aa7ec6b5f901490e27
6
+ metadata.gz: a9eb2a050e301736c58fc6a94031dc27346abc7f2058d78463ee38cd9dfb01e3e239957aa1fa6a7d7cedc9b2a597dd9c35fc2181407d65d783053488555d7bf9
7
+ data.tar.gz: 87f56f5a1580f27dd264b4b0b00b81576b66dee6883f0360a3a378eeae28a39b332f5601a3ef2cb2bd36895c64c2523f43ecf9fd6a479c701e8ca03e86f9d597
data/CHANGELOG.md CHANGED
@@ -1,6 +1,21 @@
1
1
  Unreleased Changes
2
2
  ------------------
3
3
 
4
+ 1.40.0 (2022-09-09)
5
+ ------------------
6
+
7
+ * Feature - Increases the maximum values of two RDS Performance Insights APIs. The maximum value of the Limit parameter of DimensionGroup is 25. The MaxResult maximum is now 25 for the following APIs: DescribeDimensionKeys, GetResourceMetrics, ListAvailableResourceDimensions, and ListAvailableResourceMetrics.
8
+
9
+ 1.39.0 (2022-04-07)
10
+ ------------------
11
+
12
+ * Feature - Adds support for DocumentDB to the Performance Insights API.
13
+
14
+ 1.38.0 (2022-02-24)
15
+ ------------------
16
+
17
+ * Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
18
+
4
19
  1.37.0 (2022-02-03)
5
20
  ------------------
6
21
 
data/VERSION CHANGED
@@ -1 +1 @@
1
- 1.37.0
1
+ 1.40.0
@@ -27,6 +27,7 @@ require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
27
27
  require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
28
28
  require 'aws-sdk-core/plugins/transfer_encoding.rb'
29
29
  require 'aws-sdk-core/plugins/http_checksum.rb'
30
+ require 'aws-sdk-core/plugins/checksum_algorithm.rb'
30
31
  require 'aws-sdk-core/plugins/defaults_mode.rb'
31
32
  require 'aws-sdk-core/plugins/recursion_detection.rb'
32
33
  require 'aws-sdk-core/plugins/signature_v4.rb'
@@ -75,6 +76,7 @@ module Aws::PI
75
76
  add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
76
77
  add_plugin(Aws::Plugins::TransferEncoding)
77
78
  add_plugin(Aws::Plugins::HttpChecksum)
79
+ add_plugin(Aws::Plugins::ChecksumAlgorithm)
78
80
  add_plugin(Aws::Plugins::DefaultsMode)
79
81
  add_plugin(Aws::Plugins::RecursionDetection)
80
82
  add_plugin(Aws::Plugins::SignatureV4)
@@ -370,7 +372,11 @@ module Aws::PI
370
372
  #
371
373
  # @option params [required, String] :service_type
372
374
  # The Amazon Web Services service for which Performance Insights will
373
- # return metrics. The only valid value for *ServiceType* is `RDS`.
375
+ # return metrics. Valid values are as follows:
376
+ #
377
+ # * `RDS`
378
+ #
379
+ # * `DOCDB`
374
380
  #
375
381
  # @option params [required, String] :identifier
376
382
  # An immutable, Amazon Web Services Region-unique identifier for a data
@@ -401,10 +407,10 @@ module Aws::PI
401
407
  #
402
408
  # Valid values for `Metric` are:
403
409
  #
404
- # * `db.load.avg` - a scaled representation of the number of active
410
+ # * `db.load.avg` - A scaled representation of the number of active
405
411
  # sessions for the database engine.
406
412
  #
407
- # * `db.sampledload.avg` - the raw number of active sessions for the
413
+ # * `db.sampledload.avg` - The raw number of active sessions for the
408
414
  # database engine.
409
415
  #
410
416
  # If the number of active sessions is less than an internal Performance
@@ -446,8 +452,8 @@ module Aws::PI
446
452
  # Additional metrics for the top `N` dimension keys. If the specified
447
453
  # dimension group in the `GroupBy` parameter is `db.sql_tokenized`, you
448
454
  # can specify per-SQL metrics to get the values for the top `N` SQL
449
- # digests. The response syntax is `"AdditionalMetrics" : \{ "string" :
450
- # "string" \}`.
455
+ # digests. The response syntax is as follows: `"AdditionalMetrics" : \{
456
+ # "string" : "string" \}`.
451
457
  #
452
458
  # @option params [Types::DimensionGroup] :partition_by
453
459
  # For each dimension specified in `GroupBy`, specify a secondary
@@ -538,7 +544,7 @@ module Aws::PI
538
544
  # Get the attributes of the specified dimension group for a DB instance
539
545
  # or data source. For example, if you specify a SQL ID,
540
546
  # `GetDimensionKeyDetails` retrieves the full text of the dimension
541
- # `db.sql.statement`cassociated with this ID. This operation is useful
547
+ # `db.sql.statement` associated with this ID. This operation is useful
542
548
  # because `GetResourceMetrics` and `DescribeDimensionKeys` don't
543
549
  # support retrieval of large SQL statement text.
544
550
  #
@@ -553,21 +559,35 @@ module Aws::PI
553
559
  # value. For example, specify `db-ABCDEFGHIJKLMNOPQRSTU1VW2X`.
554
560
  #
555
561
  # @option params [required, String] :group
556
- # The name of the dimension group. The only valid value is `db.sql`.
557
- # Performance Insights searches the specified group for the dimension
558
- # group ID.
562
+ # The name of the dimension group. Performance Insights searches the
563
+ # specified group for the dimension group ID. The following group name
564
+ # values are valid:
565
+ #
566
+ # * `db.query` (Amazon DocumentDB only)
567
+ #
568
+ # * `db.sql` (Amazon RDS and Aurora only)
559
569
  #
560
570
  # @option params [required, String] :group_identifier
561
571
  # The ID of the dimension group from which to retrieve dimension
562
572
  # details. For dimension group `db.sql`, the group ID is `db.sql.id`.
573
+ # The following group ID values are valid:
574
+ #
575
+ # * `db.sql.id` for dimension group `db.sql` (Aurora and RDS only)
576
+ #
577
+ # * `db.query.id` for dimension group `db.query` (DocumentDB only)
563
578
  #
564
579
  # @option params [Array<String>] :requested_dimensions
565
580
  # A list of dimensions to retrieve the detail data for within the given
566
- # dimension group. For the dimension group `db.sql`, specify either the
567
- # full dimension name `db.sql.statement` or the short dimension name
568
- # `statement`. If you don't specify this parameter, Performance
581
+ # dimension group. If you don't specify this parameter, Performance
569
582
  # Insights returns all dimension data within the specified dimension
570
- # group.
583
+ # group. Specify dimension names for the following dimension groups:
584
+ #
585
+ # * `db.sql` - Specify either the full dimension name `db.sql.statement`
586
+ # or the short dimension name `statement` (Aurora and RDS only).
587
+ #
588
+ # * `db.query` - Specify either the full dimension name
589
+ # `db.query.statement` or the short dimension name `statement`
590
+ # (DocumentDB only).
571
591
  #
572
592
  # @return [Types::GetDimensionKeyDetailsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
573
593
  #
@@ -641,10 +661,9 @@ module Aws::PI
641
661
  req.send_request(options)
642
662
  end
643
663
 
644
- # Retrieve Performance Insights metrics for a set of data sources, over
645
- # a time period. You can provide specific dimension groups and
646
- # dimensions, and provide aggregation and filtering criteria for each
647
- # group.
664
+ # Retrieve Performance Insights metrics for a set of data sources over a
665
+ # time period. You can provide specific dimension groups and dimensions,
666
+ # and provide aggregation and filtering criteria for each group.
648
667
  #
649
668
  # <note markdown="1"> Each response element returns a maximum of 500 bytes. For larger
650
669
  # elements, such as SQL statements, only the first 500 bytes are
@@ -654,14 +673,21 @@ module Aws::PI
654
673
  #
655
674
  # @option params [required, String] :service_type
656
675
  # The Amazon Web Services service for which Performance Insights returns
657
- # metrics. The only valid value for *ServiceType* is `RDS`.
676
+ # metrics. Valid values are as follows:
677
+ #
678
+ # * `RDS`
679
+ #
680
+ # * `DOCDB`
658
681
  #
659
682
  # @option params [required, String] :identifier
660
- # An immutable, Amazon Web Services Region-unique identifier for a data
661
- # source. Performance Insights gathers metrics from this data source.
683
+ # An immutable identifier for a data source that is unique for an Amazon
684
+ # Web Services Region. Performance Insights gathers metrics from this
685
+ # data source. In the console, the identifier is shown as *ResourceID*.
686
+ # When you call `DescribeDBInstances`, the identifier is returned as
687
+ # `DbiResourceId`.
662
688
  #
663
689
  # To use a DB instance as a data source, specify its `DbiResourceId`
664
- # value. For example, specify `db-FAIHNTYBKTGAUSUZQYPDS2GW4A`.
690
+ # value. For example, specify `db-ABCDEFGHIJKLMNOPQRSTU1VW2X`.
665
691
  #
666
692
  # @option params [required, Array<Types::MetricQuery>] :metric_queries
667
693
  # An array of one or more queries to perform. Each query must specify a
@@ -670,17 +696,19 @@ module Aws::PI
670
696
  #
671
697
  # @option params [required, Time,DateTime,Date,Integer,String] :start_time
672
698
  # The date and time specifying the beginning of the requested time
673
- # series data. You can't specify a `StartTime` that's earlier than 7
674
- # days ago. The value specified is *inclusive* - data points equal to or
675
- # greater than `StartTime` will be returned.
699
+ # series query range. You can't specify a `StartTime` that is earlier
700
+ # than 7 days ago. By default, Performance Insights has 7 days of
701
+ # retention, but you can extend this range up to 2 years. The value
702
+ # specified is *inclusive*. Thus, the command returns data points equal
703
+ # to or greater than `StartTime`.
676
704
  #
677
705
  # The value for `StartTime` must be earlier than the value for
678
706
  # `EndTime`.
679
707
  #
680
708
  # @option params [required, Time,DateTime,Date,Integer,String] :end_time
681
709
  # The date and time specifying the end of the requested time series
682
- # data. The value specified is *exclusive* - data points less than (but
683
- # not equal to) `EndTime` will be returned.
710
+ # query range. The value specified is *exclusive*. Thus, the command
711
+ # returns data points less than (but not equal to) `EndTime`.
684
712
  #
685
713
  # The value for `EndTime` must be later than the value for `StartTime`.
686
714
  #
@@ -855,13 +883,15 @@ module Aws::PI
855
883
  # The types of metrics to return in the response. Valid values in the
856
884
  # array include the following:
857
885
  #
858
- # * `os` (OS counter metrics)
886
+ # * `os` (OS counter metrics) - All engines
859
887
  #
860
- # * `db` (DB load metrics)
888
+ # * `db` (DB load metrics) - All engines except for Amazon DocumentDB
861
889
  #
862
- # * `db.sql.stats` (per-SQL metrics)
890
+ # * `db.sql.stats` (per-SQL metrics) - All engines except for Amazon
891
+ # DocumentDB
863
892
  #
864
- # * `db.sql_tokenized.stats` (per-SQL digest metrics)
893
+ # * `db.sql_tokenized.stats` (per-SQL digest metrics) - All engines
894
+ # except for Amazon DocumentDB
865
895
  #
866
896
  # @option params [String] :next_token
867
897
  # An optional pagination token provided by a previous request. If this
@@ -920,7 +950,7 @@ module Aws::PI
920
950
  params: params,
921
951
  config: config)
922
952
  context[:gem_name] = 'aws-sdk-pi'
923
- context[:gem_version] = '1.37.0'
953
+ context[:gem_version] = '1.40.0'
924
954
  Seahorse::Client::Request.new(handlers, context)
925
955
  end
926
956
 
@@ -60,7 +60,11 @@ module Aws::PI
60
60
  #
61
61
  # @!attribute [rw] service_type
62
62
  # The Amazon Web Services service for which Performance Insights will
63
- # return metrics. The only valid value for *ServiceType* is `RDS`.
63
+ # return metrics. Valid values are as follows:
64
+ #
65
+ # * `RDS`
66
+ #
67
+ # * `DOCDB`
64
68
  # @return [String]
65
69
  #
66
70
  # @!attribute [rw] identifier
@@ -97,10 +101,10 @@ module Aws::PI
97
101
  #
98
102
  # Valid values for `Metric` are:
99
103
  #
100
- # * `db.load.avg` - a scaled representation of the number of active
104
+ # * `db.load.avg` - A scaled representation of the number of active
101
105
  # sessions for the database engine.
102
106
  #
103
- # * `db.sampledload.avg` - the raw number of active sessions for the
107
+ # * `db.sampledload.avg` - The raw number of active sessions for the
104
108
  # database engine.
105
109
  #
106
110
  # If the number of active sessions is less than an internal
@@ -146,8 +150,8 @@ module Aws::PI
146
150
  # Additional metrics for the top `N` dimension keys. If the specified
147
151
  # dimension group in the `GroupBy` parameter is `db.sql_tokenized`,
148
152
  # you can specify per-SQL metrics to get the values for the top `N`
149
- # SQL digests. The response syntax is `"AdditionalMetrics" : \{
150
- # "string" : "string" \}`.
153
+ # SQL digests. The response syntax is as follows: `"AdditionalMetrics"
154
+ # : \{ "string" : "string" \}`.
151
155
  # @return [Array<String>]
152
156
  #
153
157
  # @!attribute [rw] partition_by
@@ -255,8 +259,19 @@ module Aws::PI
255
259
 
256
260
  # A logical grouping of Performance Insights metrics for a related
257
261
  # subject area. For example, the `db.sql` dimension group consists of
258
- # the following dimensions: `db.sql.id`, `db.sql.db_id`,
259
- # `db.sql.statement`, and `db.sql.tokenized_id`.
262
+ # the following dimensions:
263
+ #
264
+ # * `db.sql.id` - The hash of a running SQL statement, generated by
265
+ # Performance Insights.
266
+ #
267
+ # * `db.sql.db_id` - Either the SQL ID generated by the database engine,
268
+ # or a value generated by Performance Insights that begins with `pi-`.
269
+ #
270
+ # * `db.sql.statement` - The full text of the SQL statement that is
271
+ # running, for example, `SELECT * FROM employees`.
272
+ #
273
+ # * `db.sql_tokenized.id` - The hash of the SQL digest generated by
274
+ # Performance Insights.
260
275
  #
261
276
  # <note markdown="1"> Each response element returns a maximum of 500 bytes. For larger
262
277
  # elements, such as SQL statements, only the first 500 bytes are
@@ -274,31 +289,59 @@ module Aws::PI
274
289
  # }
275
290
  #
276
291
  # @!attribute [rw] group
277
- # The name of the dimension group. Valid values are:
292
+ # The name of the dimension group. Valid values are as follows:
293
+ #
294
+ # * `db` - The name of the database to which the client is connected.
295
+ # The following values are permitted:
296
+ #
297
+ # * Aurora PostgreSQL
298
+ #
299
+ # * Amazon RDS PostgreSQL
278
300
  #
279
- # * `db` - The name of the database to which the client is connected
280
- # (only Aurora PostgreSQL, Amazon RDS PostgreSQL, Aurora MySQL,
281
- # Amazon RDS MySQL, and MariaDB)
301
+ # * Aurora MySQL
302
+ #
303
+ # * Amazon RDS MySQL
304
+ #
305
+ # * Amazon RDS MariaDB
306
+ #
307
+ # * Amazon DocumentDB
282
308
  #
283
309
  # * `db.application` - The name of the application that is connected
284
- # to the database (only Aurora PostgreSQL and RDS PostgreSQL)
310
+ # to the database. The following values are permitted:
311
+ #
312
+ # * Aurora PostgreSQL
313
+ #
314
+ # * Amazon RDS PostgreSQL
315
+ #
316
+ # * Amazon DocumentDB
317
+ #
318
+ # * `db.host` - The host name of the connected client (all engines).
319
+ #
320
+ # * `db.query` - The query that is currently running (only Amazon
321
+ # DocumentDB).
285
322
  #
286
- # * `db.host` - The host name of the connected client (all engines)
323
+ # * `db.query_tokenized` - The digest query (only Amazon DocumentDB).
287
324
  #
288
325
  # * `db.session_type` - The type of the current session (only Aurora
289
- # PostgreSQL and RDS PostgreSQL)
326
+ # PostgreSQL and RDS PostgreSQL).
290
327
  #
291
- # * `db.sql` - The SQL that is currently executing (all engines)
328
+ # * `db.sql` - The text of the SQL statement that is currently running
329
+ # (all engines except Amazon DocumentDB).
292
330
  #
293
- # * `db.sql_tokenized` - The SQL digest (all engines)
331
+ # * `db.sql_tokenized` - The SQL digest (all engines except Amazon
332
+ # DocumentDB).
333
+ #
334
+ # * `db.user` - The user logged in to the database (all engines except
335
+ # Amazon DocumentDB).
294
336
  #
295
337
  # * `db.wait_event` - The event for which the database backend is
296
- # waiting (all engines)
338
+ # waiting (all engines except Amazon DocumentDB).
297
339
  #
298
340
  # * `db.wait_event_type` - The type of event for which the database
299
- # backend is waiting (all engines)
341
+ # backend is waiting (all engines except Amazon DocumentDB).
300
342
  #
301
- # * `db.user` - The user logged in to the database (all engines)
343
+ # * `db.wait_state` - The event for which the database backend is
344
+ # waiting (only Amazon DocumentDB).
302
345
  # @return [String]
303
346
  #
304
347
  # @!attribute [rw] dimensions
@@ -310,54 +353,104 @@ module Aws::PI
310
353
  # Valid values for elements in the `Dimensions` array are:
311
354
  #
312
355
  # * `db.application.name` - The name of the application that is
313
- # connected to the database (only Aurora PostgreSQL and RDS
314
- # PostgreSQL)
356
+ # connected to the database. Valid values are as follows:
357
+ #
358
+ # * Aurora PostgreSQL
359
+ #
360
+ # * Amazon RDS PostgreSQL
361
+ #
362
+ # * Amazon DocumentDB
315
363
  #
316
- # * `db.host.id` - The host ID of the connected client (all engines)
364
+ # * `db.host.id` - The host ID of the connected client (all engines).
317
365
  #
318
366
  # * `db.host.name` - The host name of the connected client (all
319
- # engines)
367
+ # engines).
320
368
  #
321
369
  # * `db.name` - The name of the database to which the client is
322
- # connected (only Aurora PostgreSQL, Amazon RDS PostgreSQL, Aurora
323
- # MySQL, Amazon RDS MySQL, and MariaDB)
370
+ # connected. Valid values are as follows:
371
+ #
372
+ # * Aurora PostgreSQL
373
+ #
374
+ # * Amazon RDS PostgreSQL
375
+ #
376
+ # * Aurora MySQL
377
+ #
378
+ # * Amazon RDS MySQL
379
+ #
380
+ # * Amazon RDS MariaDB
381
+ #
382
+ # * Amazon DocumentDB
383
+ #
384
+ # * `db.query.id` - The query ID generated by Performance Insights
385
+ # (only Amazon DocumentDB).
386
+ #
387
+ # * `db.query.db_id` - The query ID generated by the database (only
388
+ # Amazon DocumentDB).
389
+ #
390
+ # * `db.query.statement` - The text of the query that is being run
391
+ # (only Amazon DocumentDB).
392
+ #
393
+ # * `db.query.tokenized_id`
394
+ #
395
+ # * `db.query.tokenized.id` - The query digest ID generated by
396
+ # Performance Insights (only Amazon DocumentDB).
397
+ #
398
+ # * `db.query.tokenized.db_id` - The query digest ID generated by
399
+ # Performance Insights (only Amazon DocumentDB).
400
+ #
401
+ # * `db.query.tokenized.statement` - The text of the query digest
402
+ # (only Amazon DocumentDB).
324
403
  #
325
404
  # * `db.session_type.name` - The type of the current session (only
326
- # Aurora PostgreSQL and RDS PostgreSQL)
405
+ # Amazon DocumentDB).
327
406
  #
328
- # * `db.sql.id` - The SQL ID generated by Performance Insights (all
329
- # engines)
407
+ # * `db.sql.id` - The hash of the full, non-tokenized SQL statement
408
+ # generated by Performance Insights (all engines except Amazon
409
+ # DocumentDB).
330
410
  #
331
- # * `db.sql.db_id` - The SQL ID generated by the database (all
332
- # engines)
411
+ # * `db.sql.db_id` - Either the SQL ID generated by the database
412
+ # engine, or a value generated by Performance Insights that begins
413
+ # with `pi-` (all engines except Amazon DocumentDB).
333
414
  #
334
- # * `db.sql.statement` - The SQL text that is being executed (all
335
- # engines)
415
+ # * `db.sql.statement` - The full text of the SQL statement that is
416
+ # running, as in `SELECT * FROM employees` (all engines except
417
+ # Amazon DocumentDB)
336
418
  #
337
419
  # * `db.sql.tokenized_id`
338
420
  #
339
- # * `db.sql_tokenized.id` - The SQL digest ID generated by Performance
340
- # Insights (all engines)
421
+ # * `db.sql_tokenized.id` - The hash of the SQL digest generated by
422
+ # Performance Insights (all engines except Amazon DocumentDB). In
423
+ # the console, `db.sql_tokenized.id` is called the Support ID
424
+ # because Amazon Web Services Support can look at this data to help
425
+ # you troubleshoot database issues.
341
426
  #
342
- # * `db.sql_tokenized.db_id` - SQL digest ID generated by the database
343
- # (all engines)
427
+ # * `db.sql_tokenized.db_id` - Either the native database ID used to
428
+ # refer to the SQL statement, or a synthetic ID such as
429
+ # `pi-2372568224` that Performance Insights generates if the native
430
+ # database ID isn't available (all engines except Amazon
431
+ # DocumentDB).
344
432
  #
345
- # * `db.sql_tokenized.statement` - The SQL digest text (all engines)
433
+ # * `db.sql_tokenized.statement` - The text of the SQL digest, as in
434
+ # `SELECT * FROM employees WHERE employee_id = ?` (all engines
435
+ # except Amazon DocumentDB)
346
436
  #
347
437
  # * `db.user.id` - The ID of the user logged in to the database (all
348
- # engines)
438
+ # engines except Amazon DocumentDB).
349
439
  #
350
440
  # * `db.user.name` - The name of the user logged in to the database
351
- # (all engines)
441
+ # (all engines except Amazon DocumentDB).
352
442
  #
353
443
  # * `db.wait_event.name` - The event for which the backend is waiting
354
- # (all engines)
444
+ # (all engines except Amazon DocumentDB).
355
445
  #
356
446
  # * `db.wait_event.type` - The type of event for which the backend is
357
- # waiting (all engines)
447
+ # waiting (all engines except Amazon DocumentDB).
358
448
  #
359
449
  # * `db.wait_event_type.name` - The name of the event type for which
360
- # the backend is waiting (all engines)
450
+ # the backend is waiting (all engines except Amazon DocumentDB).
451
+ #
452
+ # * `db.wait_state.name` - The event for which the backend is waiting
453
+ # (only Amazon DocumentDB).
361
454
  # @return [Array<String>]
362
455
  #
363
456
  # @!attribute [rw] limit
@@ -428,14 +521,22 @@ module Aws::PI
428
521
  # An object that describes the details for a specified dimension.
429
522
  #
430
523
  # @!attribute [rw] value
431
- # The value of the dimension detail data. For the `db.sql.statement`
432
- # dimension, this value is either the full or truncated SQL query,
433
- # depending on the return status.
524
+ # The value of the dimension detail data. Depending on the return
525
+ # status, this value is either the full or truncated SQL query for the
526
+ # following dimensions:
527
+ #
528
+ # * `db.query.statement` (Amazon DocumentDB)
529
+ #
530
+ # * `db.sql.statement` (Amazon RDS and Aurora)
434
531
  # @return [String]
435
532
  #
436
533
  # @!attribute [rw] dimension
437
534
  # The full name of the dimension. The full name includes the group
438
- # name and key name. The only valid value is `db.sql.statement`.
535
+ # name and key name. The following values are valid:
536
+ #
537
+ # * `db.query.statement` (Amazon DocumentDB)
538
+ #
539
+ # * `db.sql.statement` (Amazon RDS and Aurora)
439
540
  # @return [String]
440
541
  #
441
542
  # @!attribute [rw] status
@@ -446,8 +547,8 @@ module Aws::PI
446
547
  #
447
548
  # * `PROCESSING` - The dimension detail data isn't ready to be
448
549
  # retrieved because more processing time is required. If the
449
- # requested detail data for `db.sql.statement` has the status
450
- # `PROCESSING`, Performance Insights returns the truncated query.
550
+ # requested detail data has the status `PROCESSING`, Performance
551
+ # Insights returns the truncated query.
451
552
  #
452
553
  # * `UNAVAILABLE` - The dimension detail data could not be collected
453
554
  # successfully.
@@ -470,19 +571,19 @@ module Aws::PI
470
571
  # The status of the feature on the DB instance. Possible values
471
572
  # include the following:
472
573
  #
473
- # * `ENABLED`\: the feature is enabled on the instance.
574
+ # * `ENABLED` - The feature is enabled on the instance.
474
575
  #
475
- # * `DISABLED`\: the feature is disabled on the instance.
576
+ # * `DISABLED` - The feature is disabled on the instance.
476
577
  #
477
- # * `UNSUPPORTED`\: the feature isn't supported on the instance.
578
+ # * `UNSUPPORTED` - The feature isn't supported on the instance.
478
579
  #
479
- # * `ENABLED_PENDING_REBOOT`\: the feature is enabled on the instance
580
+ # * `ENABLED_PENDING_REBOOT` - The feature is enabled on the instance
480
581
  # but requires a reboot to take effect.
481
582
  #
482
- # * `DISABLED_PENDING_REBOOT`\: the feature is disabled on the
583
+ # * `DISABLED_PENDING_REBOOT` - The feature is disabled on the
483
584
  # instance but requires a reboot to take effect.
484
585
  #
485
- # * `UNKNOWN`\: the feature status couldn't be determined.
586
+ # * `UNKNOWN` - The feature status couldn't be determined.
486
587
  # @return [String]
487
588
  #
488
589
  # @see http://docs.aws.amazon.com/goto/WebAPI/pi-2018-02-27/FeatureMetadata AWS API Documentation
@@ -518,23 +619,39 @@ module Aws::PI
518
619
  # @return [String]
519
620
  #
520
621
  # @!attribute [rw] group
521
- # The name of the dimension group. The only valid value is `db.sql`.
522
- # Performance Insights searches the specified group for the dimension
523
- # group ID.
622
+ # The name of the dimension group. Performance Insights searches the
623
+ # specified group for the dimension group ID. The following group name
624
+ # values are valid:
625
+ #
626
+ # * `db.query` (Amazon DocumentDB only)
627
+ #
628
+ # * `db.sql` (Amazon RDS and Aurora only)
524
629
  # @return [String]
525
630
  #
526
631
  # @!attribute [rw] group_identifier
527
632
  # The ID of the dimension group from which to retrieve dimension
528
633
  # details. For dimension group `db.sql`, the group ID is `db.sql.id`.
634
+ # The following group ID values are valid:
635
+ #
636
+ # * `db.sql.id` for dimension group `db.sql` (Aurora and RDS only)
637
+ #
638
+ # * `db.query.id` for dimension group `db.query` (DocumentDB only)
529
639
  # @return [String]
530
640
  #
531
641
  # @!attribute [rw] requested_dimensions
532
642
  # A list of dimensions to retrieve the detail data for within the
533
- # given dimension group. For the dimension group `db.sql`, specify
534
- # either the full dimension name `db.sql.statement` or the short
535
- # dimension name `statement`. If you don't specify this parameter,
643
+ # given dimension group. If you don't specify this parameter,
536
644
  # Performance Insights returns all dimension data within the specified
537
- # dimension group.
645
+ # dimension group. Specify dimension names for the following dimension
646
+ # groups:
647
+ #
648
+ # * `db.sql` - Specify either the full dimension name
649
+ # `db.sql.statement` or the short dimension name `statement` (Aurora
650
+ # and RDS only).
651
+ #
652
+ # * `db.query` - Specify either the full dimension name
653
+ # `db.query.statement` or the short dimension name `statement`
654
+ # (DocumentDB only).
538
655
  # @return [Array<String>]
539
656
  #
540
657
  # @see http://docs.aws.amazon.com/goto/WebAPI/pi-2018-02-27/GetDimensionKeyDetailsRequest AWS API Documentation
@@ -642,16 +759,22 @@ module Aws::PI
642
759
  #
643
760
  # @!attribute [rw] service_type
644
761
  # The Amazon Web Services service for which Performance Insights
645
- # returns metrics. The only valid value for *ServiceType* is `RDS`.
762
+ # returns metrics. Valid values are as follows:
763
+ #
764
+ # * `RDS`
765
+ #
766
+ # * `DOCDB`
646
767
  # @return [String]
647
768
  #
648
769
  # @!attribute [rw] identifier
649
- # An immutable, Amazon Web Services Region-unique identifier for a
650
- # data source. Performance Insights gathers metrics from this data
651
- # source.
770
+ # An immutable identifier for a data source that is unique for an
771
+ # Amazon Web Services Region. Performance Insights gathers metrics
772
+ # from this data source. In the console, the identifier is shown as
773
+ # *ResourceID*. When you call `DescribeDBInstances`, the identifier is
774
+ # returned as `DbiResourceId`.
652
775
  #
653
776
  # To use a DB instance as a data source, specify its `DbiResourceId`
654
- # value. For example, specify `db-FAIHNTYBKTGAUSUZQYPDS2GW4A`.
777
+ # value. For example, specify `db-ABCDEFGHIJKLMNOPQRSTU1VW2X`.
655
778
  # @return [String]
656
779
  #
657
780
  # @!attribute [rw] metric_queries
@@ -662,9 +785,11 @@ module Aws::PI
662
785
  #
663
786
  # @!attribute [rw] start_time
664
787
  # The date and time specifying the beginning of the requested time
665
- # series data. You can't specify a `StartTime` that's earlier than 7
666
- # days ago. The value specified is *inclusive* - data points equal to
667
- # or greater than `StartTime` will be returned.
788
+ # series query range. You can't specify a `StartTime` that is earlier
789
+ # than 7 days ago. By default, Performance Insights has 7 days of
790
+ # retention, but you can extend this range up to 2 years. The value
791
+ # specified is *inclusive*. Thus, the command returns data points
792
+ # equal to or greater than `StartTime`.
668
793
  #
669
794
  # The value for `StartTime` must be earlier than the value for
670
795
  # `EndTime`.
@@ -672,8 +797,8 @@ module Aws::PI
672
797
  #
673
798
  # @!attribute [rw] end_time
674
799
  # The date and time specifying the end of the requested time series
675
- # data. The value specified is *exclusive* - data points less than
676
- # (but not equal to) `EndTime` will be returned.
800
+ # query range. The value specified is *exclusive*. Thus, the command
801
+ # returns data points less than (but not equal to) `EndTime`.
677
802
  #
678
803
  # The value for `EndTime` must be later than the value for
679
804
  # `StartTime`.
@@ -742,17 +867,16 @@ module Aws::PI
742
867
  # @return [Time]
743
868
  #
744
869
  # @!attribute [rw] identifier
745
- # An immutable, Amazon Web Services Region-unique identifier for a
746
- # data source. Performance Insights gathers metrics from this data
747
- # source.
748
- #
749
- # To use a DB instance as a data source, you specify its
750
- # `DbiResourceId` value - for example: `db-FAIHNTYBKTGAUSUZQYPDS2GW4A`
870
+ # An immutable identifier for a data source that is unique for an
871
+ # Amazon Web Services Region. Performance Insights gathers metrics
872
+ # from this data source. In the console, the identifier is shown as
873
+ # *ResourceID*. When you call `DescribeDBInstances`, the identifier is
874
+ # returned as `DbiResourceId`.
751
875
  # @return [String]
752
876
  #
753
877
  # @!attribute [rw] metric_list
754
- # An array of metric results,, where each array element contains all
755
- # of the data points for a particular dimension.
878
+ # An array of metric results, where each array element contains all of
879
+ # the data points for a particular dimension.
756
880
  # @return [Array<Types::MetricKeyDataPoints>]
757
881
  #
758
882
  # @!attribute [rw] next_token
@@ -900,13 +1024,15 @@ module Aws::PI
900
1024
  # The types of metrics to return in the response. Valid values in the
901
1025
  # array include the following:
902
1026
  #
903
- # * `os` (OS counter metrics)
1027
+ # * `os` (OS counter metrics) - All engines
904
1028
  #
905
- # * `db` (DB load metrics)
1029
+ # * `db` (DB load metrics) - All engines except for Amazon DocumentDB
906
1030
  #
907
- # * `db.sql.stats` (per-SQL metrics)
1031
+ # * `db.sql.stats` (per-SQL metrics) - All engines except for Amazon
1032
+ # DocumentDB
908
1033
  #
909
- # * `db.sql_tokenized.stats` (per-SQL digest metrics)
1034
+ # * `db.sql_tokenized.stats` (per-SQL digest metrics) - All engines
1035
+ # except for Amazon DocumentDB
910
1036
  # @return [Array<String>]
911
1037
  #
912
1038
  # @!attribute [rw] next_token
@@ -1020,12 +1146,15 @@ module Aws::PI
1020
1146
  #
1021
1147
  # Valid values for `Metric` are:
1022
1148
  #
1023
- # * `db.load.avg` - a scaled representation of the number of active
1149
+ # * `db.load.avg` - A scaled representation of the number of active
1024
1150
  # sessions for the database engine.
1025
1151
  #
1026
- # * `db.sampledload.avg` - the raw number of active sessions for the
1152
+ # * `db.sampledload.avg` - The raw number of active sessions for the
1027
1153
  # database engine.
1028
1154
  #
1155
+ # * The counter metrics listed in [Performance Insights operating
1156
+ # system counters][1] in the *Amazon Aurora User Guide*.
1157
+ #
1029
1158
  # If the number of active sessions is less than an internal
1030
1159
  # Performance Insights threshold, `db.load.avg` and
1031
1160
  # `db.sampledload.avg` are the same value. If the number of active
@@ -1034,6 +1163,10 @@ module Aws::PI
1034
1163
  # scaled values, `db.sampledload.avg` showing the raw values, and
1035
1164
  # `db.sampledload.avg` less than `db.load.avg`. For most use cases,
1036
1165
  # you can query `db.load.avg` only.
1166
+ #
1167
+ #
1168
+ #
1169
+ # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_PerfInsights_Counters.html#USER_PerfInsights_Counters.OS
1037
1170
  # @return [String]
1038
1171
  #
1039
1172
  # @!attribute [rw] group_by
@@ -1126,12 +1259,15 @@ module Aws::PI
1126
1259
  #
1127
1260
  # Valid values for `Metric` are:
1128
1261
  #
1129
- # * `db.load.avg` - a scaled representation of the number of active
1262
+ # * `db.load.avg` - A scaled representation of the number of active
1130
1263
  # sessions for the database engine.
1131
1264
  #
1132
- # * `db.sampledload.avg` - the raw number of active sessions for the
1265
+ # * `db.sampledload.avg` - The raw number of active sessions for the
1133
1266
  # database engine.
1134
1267
  #
1268
+ # * The counter metrics listed in [Performance Insights operating
1269
+ # system counters][1] in the *Amazon Aurora User Guide*.
1270
+ #
1135
1271
  # If the number of active sessions is less than an internal
1136
1272
  # Performance Insights threshold, `db.load.avg` and
1137
1273
  # `db.sampledload.avg` are the same value. If the number of active
@@ -1140,6 +1276,10 @@ module Aws::PI
1140
1276
  # scaled values, `db.sampledload.avg` showing the raw values, and
1141
1277
  # `db.sampledload.avg` less than `db.load.avg`. For most use cases,
1142
1278
  # you can query `db.load.avg` only.
1279
+ #
1280
+ #
1281
+ #
1282
+ # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_PerfInsights_Counters.html#USER_PerfInsights_Counters.OS
1143
1283
  # @return [String]
1144
1284
  #
1145
1285
  # @!attribute [rw] dimensions
data/lib/aws-sdk-pi.rb CHANGED
@@ -48,6 +48,6 @@ require_relative 'aws-sdk-pi/customizations'
48
48
  # @!group service
49
49
  module Aws::PI
50
50
 
51
- GEM_VERSION = '1.37.0'
51
+ GEM_VERSION = '1.40.0'
52
52
 
53
53
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: aws-sdk-pi
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.37.0
4
+ version: 1.40.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Amazon Web Services
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2022-02-03 00:00:00.000000000 Z
11
+ date: 2022-09-09 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: aws-sdk-core
@@ -19,7 +19,7 @@ dependencies:
19
19
  version: '3'
20
20
  - - ">="
21
21
  - !ruby/object:Gem::Version
22
- version: 3.126.0
22
+ version: 3.127.0
23
23
  type: :runtime
24
24
  prerelease: false
25
25
  version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
29
29
  version: '3'
30
30
  - - ">="
31
31
  - !ruby/object:Gem::Version
32
- version: 3.126.0
32
+ version: 3.127.0
33
33
  - !ruby/object:Gem::Dependency
34
34
  name: aws-sigv4
35
35
  requirement: !ruby/object:Gem::Requirement