aws-sdk-pi 1.33.0 → 1.37.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +20 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-pi/client.rb +225 -21
- data/lib/aws-sdk-pi/client_api.rb +150 -0
- data/lib/aws-sdk-pi/types.rb +368 -33
- data/lib/aws-sdk-pi.rb +1 -1
- metadata +4 -4
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 5224d1880c1244150f804309885e31a6d570cdbc35a88ac126ce115b5fcfe102
|
4
|
+
data.tar.gz: c05dc07afad0f9239f3f606a2135e5a7e90a69ba1111e6dbefd8548f0cea29b9
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 0d73327d6454d9e0288426f1b9595dc2aa71876a351f9be7a4e76876b1eb893df18d25747ca08809b8f0df3194a9a2d870352925983833369d8261a8cce9757f
|
7
|
+
data.tar.gz: 7e24f5b28d19d279b22c96f42916b5ce611c1caaeefe23dfa8de6b062b25515cb593895188101f28ac6faf984fa07a19f8f9c94d369053aa7ec6b5f901490e27
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,26 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.37.0 (2022-02-03)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
8
|
+
|
9
|
+
1.36.0 (2022-01-12)
|
10
|
+
------------------
|
11
|
+
|
12
|
+
* Feature - This release adds three Performance Insights APIs. Use ListAvailableResourceMetrics to get available metrics, GetResourceMetadata to get feature metadata, and ListAvailableResourceDimensions to list available dimensions. The AdditionalMetrics field in DescribeDimensionKeys retrieves per-SQL metrics.
|
13
|
+
|
14
|
+
1.35.0 (2021-12-21)
|
15
|
+
------------------
|
16
|
+
|
17
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
18
|
+
|
19
|
+
1.34.0 (2021-11-30)
|
20
|
+
------------------
|
21
|
+
|
22
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
23
|
+
|
4
24
|
1.33.0 (2021-11-04)
|
5
25
|
------------------
|
6
26
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.37.0
|
data/lib/aws-sdk-pi/client.rb
CHANGED
@@ -27,6 +27,8 @@ 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/defaults_mode.rb'
|
31
|
+
require 'aws-sdk-core/plugins/recursion_detection.rb'
|
30
32
|
require 'aws-sdk-core/plugins/signature_v4.rb'
|
31
33
|
require 'aws-sdk-core/plugins/protocols/json_rpc.rb'
|
32
34
|
|
@@ -73,6 +75,8 @@ module Aws::PI
|
|
73
75
|
add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
|
74
76
|
add_plugin(Aws::Plugins::TransferEncoding)
|
75
77
|
add_plugin(Aws::Plugins::HttpChecksum)
|
78
|
+
add_plugin(Aws::Plugins::DefaultsMode)
|
79
|
+
add_plugin(Aws::Plugins::RecursionDetection)
|
76
80
|
add_plugin(Aws::Plugins::SignatureV4)
|
77
81
|
add_plugin(Aws::Plugins::Protocols::JsonRpc)
|
78
82
|
|
@@ -119,7 +123,9 @@ module Aws::PI
|
|
119
123
|
# * EC2/ECS IMDS instance profile - When used by default, the timeouts
|
120
124
|
# are very aggressive. Construct and pass an instance of
|
121
125
|
# `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to
|
122
|
-
# enable retries and extended timeouts.
|
126
|
+
# enable retries and extended timeouts. Instance profile credential
|
127
|
+
# fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED']
|
128
|
+
# to true.
|
123
129
|
#
|
124
130
|
# @option options [required, String] :region
|
125
131
|
# The AWS region to connect to. The configured `:region` is
|
@@ -173,6 +179,10 @@ module Aws::PI
|
|
173
179
|
# Used only in `standard` and adaptive retry modes. Specifies whether to apply
|
174
180
|
# a clock skew correction and retry requests with skewed client clocks.
|
175
181
|
#
|
182
|
+
# @option options [String] :defaults_mode ("legacy")
|
183
|
+
# See {Aws::DefaultsModeConfiguration} for a list of the
|
184
|
+
# accepted modes and the configuration defaults that are included.
|
185
|
+
#
|
176
186
|
# @option options [Boolean] :disable_host_prefix_injection (false)
|
177
187
|
# Set to true to disable SDK automatically adding host prefix
|
178
188
|
# to default service endpoint when available.
|
@@ -305,7 +315,7 @@ module Aws::PI
|
|
305
315
|
# seconds to wait when opening a HTTP session before raising a
|
306
316
|
# `Timeout::Error`.
|
307
317
|
#
|
308
|
-
# @option options [
|
318
|
+
# @option options [Float] :http_read_timeout (60) The default
|
309
319
|
# number of seconds to wait for response data. This value can
|
310
320
|
# safely be set per-request on the session.
|
311
321
|
#
|
@@ -321,6 +331,9 @@ module Aws::PI
|
|
321
331
|
# disables this behaviour. This value can safely be set per
|
322
332
|
# request on the session.
|
323
333
|
#
|
334
|
+
# @option options [Float] :ssl_timeout (nil) Sets the SSL timeout
|
335
|
+
# in seconds.
|
336
|
+
#
|
324
337
|
# @option options [Boolean] :http_wire_trace (false) When `true`,
|
325
338
|
# HTTP debug output will be sent to the `:logger`.
|
326
339
|
#
|
@@ -356,16 +369,16 @@ module Aws::PI
|
|
356
369
|
# </note>
|
357
370
|
#
|
358
371
|
# @option params [required, String] :service_type
|
359
|
-
# The
|
360
|
-
# The only valid value for *ServiceType* is `RDS`.
|
372
|
+
# The Amazon Web Services service for which Performance Insights will
|
373
|
+
# return metrics. The only valid value for *ServiceType* is `RDS`.
|
361
374
|
#
|
362
375
|
# @option params [required, String] :identifier
|
363
|
-
# An immutable,
|
364
|
-
# Performance Insights gathers metrics from this data source.
|
376
|
+
# An immutable, Amazon Web Services Region-unique identifier for a data
|
377
|
+
# source. Performance Insights gathers metrics from this data source.
|
365
378
|
#
|
366
379
|
# To use an Amazon RDS instance as a data source, you specify its
|
367
380
|
# `DbiResourceId` value. For example, specify
|
368
|
-
# `db-FAIHNTYBKTGAUSUZQYPDS2GW4A
|
381
|
+
# `db-FAIHNTYBKTGAUSUZQYPDS2GW4A`.
|
369
382
|
#
|
370
383
|
# @option params [required, Time,DateTime,Date,Integer,String] :start_time
|
371
384
|
# The date and time specifying the beginning of the requested time
|
@@ -429,6 +442,13 @@ module Aws::PI
|
|
429
442
|
# Performance Insights return a limited number of values for a
|
430
443
|
# dimension.
|
431
444
|
#
|
445
|
+
# @option params [Array<String>] :additional_metrics
|
446
|
+
# Additional metrics for the top `N` dimension keys. If the specified
|
447
|
+
# dimension group in the `GroupBy` parameter is `db.sql_tokenized`, you
|
448
|
+
# can specify per-SQL metrics to get the values for the top `N` SQL
|
449
|
+
# digests. The response syntax is `"AdditionalMetrics" : \{ "string" :
|
450
|
+
# "string" \}`.
|
451
|
+
#
|
432
452
|
# @option params [Types::DimensionGroup] :partition_by
|
433
453
|
# For each dimension specified in `GroupBy`, specify a secondary
|
434
454
|
# dimension to further subdivide the partition keys in the response.
|
@@ -460,10 +480,12 @@ module Aws::PI
|
|
460
480
|
# * {Types::DescribeDimensionKeysResponse#keys #keys} => Array<Types::DimensionKeyDescription>
|
461
481
|
# * {Types::DescribeDimensionKeysResponse#next_token #next_token} => String
|
462
482
|
#
|
483
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
484
|
+
#
|
463
485
|
# @example Request syntax with placeholder values
|
464
486
|
#
|
465
487
|
# resp = client.describe_dimension_keys({
|
466
|
-
# service_type: "RDS", # required, accepts RDS
|
488
|
+
# service_type: "RDS", # required, accepts RDS, DOCDB
|
467
489
|
# identifier: "RequestString", # required
|
468
490
|
# start_time: Time.now, # required
|
469
491
|
# end_time: Time.now, # required
|
@@ -474,6 +496,7 @@ module Aws::PI
|
|
474
496
|
# dimensions: ["RequestString"],
|
475
497
|
# limit: 1,
|
476
498
|
# },
|
499
|
+
# additional_metrics: ["RequestString"],
|
477
500
|
# partition_by: {
|
478
501
|
# group: "RequestString", # required
|
479
502
|
# dimensions: ["RequestString"],
|
@@ -497,6 +520,8 @@ module Aws::PI
|
|
497
520
|
# resp.keys[0].dimensions #=> Hash
|
498
521
|
# resp.keys[0].dimensions["RequestString"] #=> String
|
499
522
|
# resp.keys[0].total #=> Float
|
523
|
+
# resp.keys[0].additional_metrics #=> Hash
|
524
|
+
# resp.keys[0].additional_metrics["RequestString"] #=> Float
|
500
525
|
# resp.keys[0].partitions #=> Array
|
501
526
|
# resp.keys[0].partitions[0] #=> Float
|
502
527
|
# resp.next_token #=> String
|
@@ -513,19 +538,19 @@ module Aws::PI
|
|
513
538
|
# Get the attributes of the specified dimension group for a DB instance
|
514
539
|
# or data source. For example, if you specify a SQL ID,
|
515
540
|
# `GetDimensionKeyDetails` retrieves the full text of the dimension
|
516
|
-
# `db.sql.statement`
|
541
|
+
# `db.sql.statement`cassociated with this ID. This operation is useful
|
517
542
|
# because `GetResourceMetrics` and `DescribeDimensionKeys` don't
|
518
543
|
# support retrieval of large SQL statement text.
|
519
544
|
#
|
520
545
|
# @option params [required, String] :service_type
|
521
|
-
# The
|
522
|
-
# valid value is `RDS`.
|
546
|
+
# The Amazon Web Services service for which Performance Insights returns
|
547
|
+
# data. The only valid value is `RDS`.
|
523
548
|
#
|
524
549
|
# @option params [required, String] :identifier
|
525
550
|
# The ID for a data source from which to gather dimension data. This ID
|
526
|
-
# must be immutable and unique within an
|
527
|
-
# is the data source, specify its `DbiResourceId`
|
528
|
-
# specify `db-ABCDEFGHIJKLMNOPQRSTU1VW2X`.
|
551
|
+
# must be immutable and unique within an Amazon Web Services Region.
|
552
|
+
# When a DB instance is the data source, specify its `DbiResourceId`
|
553
|
+
# value. For example, specify `db-ABCDEFGHIJKLMNOPQRSTU1VW2X`.
|
529
554
|
#
|
530
555
|
# @option params [required, String] :group
|
531
556
|
# The name of the dimension group. The only valid value is `db.sql`.
|
@@ -551,7 +576,7 @@ module Aws::PI
|
|
551
576
|
# @example Request syntax with placeholder values
|
552
577
|
#
|
553
578
|
# resp = client.get_dimension_key_details({
|
554
|
-
# service_type: "RDS", # required, accepts RDS
|
579
|
+
# service_type: "RDS", # required, accepts RDS, DOCDB
|
555
580
|
# identifier: "IdentifierString", # required
|
556
581
|
# group: "RequestString", # required
|
557
582
|
# group_identifier: "RequestString", # required
|
@@ -574,6 +599,48 @@ module Aws::PI
|
|
574
599
|
req.send_request(options)
|
575
600
|
end
|
576
601
|
|
602
|
+
# Retrieve the metadata for different features. For example, the
|
603
|
+
# metadata might indicate that a feature is turned on or off on a
|
604
|
+
# specific DB instance.
|
605
|
+
#
|
606
|
+
# @option params [required, String] :service_type
|
607
|
+
# The Amazon Web Services service for which Performance Insights returns
|
608
|
+
# metrics.
|
609
|
+
#
|
610
|
+
# @option params [required, String] :identifier
|
611
|
+
# An immutable identifier for a data source that is unique for an Amazon
|
612
|
+
# Web Services Region. Performance Insights gathers metrics from this
|
613
|
+
# data source. To use a DB instance as a data source, specify its
|
614
|
+
# `DbiResourceId` value. For example, specify
|
615
|
+
# `db-ABCDEFGHIJKLMNOPQRSTU1VW2X`.
|
616
|
+
#
|
617
|
+
# @return [Types::GetResourceMetadataResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
618
|
+
#
|
619
|
+
# * {Types::GetResourceMetadataResponse#identifier #identifier} => String
|
620
|
+
# * {Types::GetResourceMetadataResponse#features #features} => Hash<String,Types::FeatureMetadata>
|
621
|
+
#
|
622
|
+
# @example Request syntax with placeholder values
|
623
|
+
#
|
624
|
+
# resp = client.get_resource_metadata({
|
625
|
+
# service_type: "RDS", # required, accepts RDS, DOCDB
|
626
|
+
# identifier: "RequestString", # required
|
627
|
+
# })
|
628
|
+
#
|
629
|
+
# @example Response structure
|
630
|
+
#
|
631
|
+
# resp.identifier #=> String
|
632
|
+
# resp.features #=> Hash
|
633
|
+
# resp.features["String"].status #=> String, one of "ENABLED", "DISABLED", "UNSUPPORTED", "ENABLED_PENDING_REBOOT", "DISABLED_PENDING_REBOOT", "UNKNOWN"
|
634
|
+
#
|
635
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pi-2018-02-27/GetResourceMetadata AWS API Documentation
|
636
|
+
#
|
637
|
+
# @overload get_resource_metadata(params = {})
|
638
|
+
# @param [Hash] params ({})
|
639
|
+
def get_resource_metadata(params = {}, options = {})
|
640
|
+
req = build_request(:get_resource_metadata, params)
|
641
|
+
req.send_request(options)
|
642
|
+
end
|
643
|
+
|
577
644
|
# Retrieve Performance Insights metrics for a set of data sources, over
|
578
645
|
# a time period. You can provide specific dimension groups and
|
579
646
|
# dimensions, and provide aggregation and filtering criteria for each
|
@@ -586,12 +653,12 @@ module Aws::PI
|
|
586
653
|
# </note>
|
587
654
|
#
|
588
655
|
# @option params [required, String] :service_type
|
589
|
-
# The
|
590
|
-
# only valid value for *ServiceType* is `RDS`.
|
656
|
+
# The Amazon Web Services service for which Performance Insights returns
|
657
|
+
# metrics. The only valid value for *ServiceType* is `RDS`.
|
591
658
|
#
|
592
659
|
# @option params [required, String] :identifier
|
593
|
-
# An immutable,
|
594
|
-
# Performance Insights gathers metrics from this data source.
|
660
|
+
# An immutable, Amazon Web Services Region-unique identifier for a data
|
661
|
+
# source. Performance Insights gathers metrics from this data source.
|
595
662
|
#
|
596
663
|
# To use a DB instance as a data source, specify its `DbiResourceId`
|
597
664
|
# value. For example, specify `db-FAIHNTYBKTGAUSUZQYPDS2GW4A`.
|
@@ -655,10 +722,12 @@ module Aws::PI
|
|
655
722
|
# * {Types::GetResourceMetricsResponse#metric_list #metric_list} => Array<Types::MetricKeyDataPoints>
|
656
723
|
# * {Types::GetResourceMetricsResponse#next_token #next_token} => String
|
657
724
|
#
|
725
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
726
|
+
#
|
658
727
|
# @example Request syntax with placeholder values
|
659
728
|
#
|
660
729
|
# resp = client.get_resource_metrics({
|
661
|
-
# service_type: "RDS", # required, accepts RDS
|
730
|
+
# service_type: "RDS", # required, accepts RDS, DOCDB
|
662
731
|
# identifier: "RequestString", # required
|
663
732
|
# metric_queries: [ # required
|
664
733
|
# {
|
@@ -703,6 +772,141 @@ module Aws::PI
|
|
703
772
|
req.send_request(options)
|
704
773
|
end
|
705
774
|
|
775
|
+
# Retrieve the dimensions that can be queried for each specified metric
|
776
|
+
# type on a specified DB instance.
|
777
|
+
#
|
778
|
+
# @option params [required, String] :service_type
|
779
|
+
# The Amazon Web Services service for which Performance Insights returns
|
780
|
+
# metrics.
|
781
|
+
#
|
782
|
+
# @option params [required, String] :identifier
|
783
|
+
# An immutable identifier for a data source that is unique within an
|
784
|
+
# Amazon Web Services Region. Performance Insights gathers metrics from
|
785
|
+
# this data source. To use an Amazon RDS DB instance as a data source,
|
786
|
+
# specify its `DbiResourceId` value. For example, specify
|
787
|
+
# `db-ABCDEFGHIJKLMNOPQRSTU1VWZ`.
|
788
|
+
#
|
789
|
+
# @option params [required, Array<String>] :metrics
|
790
|
+
# The types of metrics for which to retrieve dimensions. Valid values
|
791
|
+
# include `db.load`.
|
792
|
+
#
|
793
|
+
# @option params [Integer] :max_results
|
794
|
+
# The maximum number of items to return in the response. If more items
|
795
|
+
# exist than the specified `MaxRecords` value, a pagination token is
|
796
|
+
# included in the response so that the remaining results can be
|
797
|
+
# retrieved.
|
798
|
+
#
|
799
|
+
# @option params [String] :next_token
|
800
|
+
# An optional pagination token provided by a previous request. If this
|
801
|
+
# parameter is specified, the response includes only records beyond the
|
802
|
+
# token, up to the value specified by `MaxRecords`.
|
803
|
+
#
|
804
|
+
# @return [Types::ListAvailableResourceDimensionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
805
|
+
#
|
806
|
+
# * {Types::ListAvailableResourceDimensionsResponse#metric_dimensions #metric_dimensions} => Array<Types::MetricDimensionGroups>
|
807
|
+
# * {Types::ListAvailableResourceDimensionsResponse#next_token #next_token} => String
|
808
|
+
#
|
809
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
810
|
+
#
|
811
|
+
# @example Request syntax with placeholder values
|
812
|
+
#
|
813
|
+
# resp = client.list_available_resource_dimensions({
|
814
|
+
# service_type: "RDS", # required, accepts RDS, DOCDB
|
815
|
+
# identifier: "RequestString", # required
|
816
|
+
# metrics: ["RequestString"], # required
|
817
|
+
# max_results: 1,
|
818
|
+
# next_token: "NextToken",
|
819
|
+
# })
|
820
|
+
#
|
821
|
+
# @example Response structure
|
822
|
+
#
|
823
|
+
# resp.metric_dimensions #=> Array
|
824
|
+
# resp.metric_dimensions[0].metric #=> String
|
825
|
+
# resp.metric_dimensions[0].groups #=> Array
|
826
|
+
# resp.metric_dimensions[0].groups[0].group #=> String
|
827
|
+
# resp.metric_dimensions[0].groups[0].dimensions #=> Array
|
828
|
+
# resp.metric_dimensions[0].groups[0].dimensions[0].identifier #=> String
|
829
|
+
# resp.next_token #=> String
|
830
|
+
#
|
831
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pi-2018-02-27/ListAvailableResourceDimensions AWS API Documentation
|
832
|
+
#
|
833
|
+
# @overload list_available_resource_dimensions(params = {})
|
834
|
+
# @param [Hash] params ({})
|
835
|
+
def list_available_resource_dimensions(params = {}, options = {})
|
836
|
+
req = build_request(:list_available_resource_dimensions, params)
|
837
|
+
req.send_request(options)
|
838
|
+
end
|
839
|
+
|
840
|
+
# Retrieve metrics of the specified types that can be queried for a
|
841
|
+
# specified DB instance.
|
842
|
+
#
|
843
|
+
# @option params [required, String] :service_type
|
844
|
+
# The Amazon Web Services service for which Performance Insights returns
|
845
|
+
# metrics.
|
846
|
+
#
|
847
|
+
# @option params [required, String] :identifier
|
848
|
+
# An immutable identifier for a data source that is unique within an
|
849
|
+
# Amazon Web Services Region. Performance Insights gathers metrics from
|
850
|
+
# this data source. To use an Amazon RDS DB instance as a data source,
|
851
|
+
# specify its `DbiResourceId` value. For example, specify
|
852
|
+
# `db-ABCDEFGHIJKLMNOPQRSTU1VWZ`.
|
853
|
+
#
|
854
|
+
# @option params [required, Array<String>] :metric_types
|
855
|
+
# The types of metrics to return in the response. Valid values in the
|
856
|
+
# array include the following:
|
857
|
+
#
|
858
|
+
# * `os` (OS counter metrics)
|
859
|
+
#
|
860
|
+
# * `db` (DB load metrics)
|
861
|
+
#
|
862
|
+
# * `db.sql.stats` (per-SQL metrics)
|
863
|
+
#
|
864
|
+
# * `db.sql_tokenized.stats` (per-SQL digest metrics)
|
865
|
+
#
|
866
|
+
# @option params [String] :next_token
|
867
|
+
# An optional pagination token provided by a previous request. If this
|
868
|
+
# parameter is specified, the response includes only records beyond the
|
869
|
+
# token, up to the value specified by `MaxRecords`.
|
870
|
+
#
|
871
|
+
# @option params [Integer] :max_results
|
872
|
+
# The maximum number of items to return. If the `MaxRecords` value is
|
873
|
+
# less than the number of existing items, the response includes a
|
874
|
+
# pagination token.
|
875
|
+
#
|
876
|
+
# @return [Types::ListAvailableResourceMetricsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
877
|
+
#
|
878
|
+
# * {Types::ListAvailableResourceMetricsResponse#metrics #metrics} => Array<Types::ResponseResourceMetric>
|
879
|
+
# * {Types::ListAvailableResourceMetricsResponse#next_token #next_token} => String
|
880
|
+
#
|
881
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
882
|
+
#
|
883
|
+
# @example Request syntax with placeholder values
|
884
|
+
#
|
885
|
+
# resp = client.list_available_resource_metrics({
|
886
|
+
# service_type: "RDS", # required, accepts RDS, DOCDB
|
887
|
+
# identifier: "RequestString", # required
|
888
|
+
# metric_types: ["RequestString"], # required
|
889
|
+
# next_token: "NextToken",
|
890
|
+
# max_results: 1,
|
891
|
+
# })
|
892
|
+
#
|
893
|
+
# @example Response structure
|
894
|
+
#
|
895
|
+
# resp.metrics #=> Array
|
896
|
+
# resp.metrics[0].metric #=> String
|
897
|
+
# resp.metrics[0].description #=> String
|
898
|
+
# resp.metrics[0].unit #=> String
|
899
|
+
# resp.next_token #=> String
|
900
|
+
#
|
901
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pi-2018-02-27/ListAvailableResourceMetrics AWS API Documentation
|
902
|
+
#
|
903
|
+
# @overload list_available_resource_metrics(params = {})
|
904
|
+
# @param [Hash] params ({})
|
905
|
+
def list_available_resource_metrics(params = {}, options = {})
|
906
|
+
req = build_request(:list_available_resource_metrics, params)
|
907
|
+
req.send_request(options)
|
908
|
+
end
|
909
|
+
|
706
910
|
# @!endgroup
|
707
911
|
|
708
912
|
# @param params ({})
|
@@ -716,7 +920,7 @@ module Aws::PI
|
|
716
920
|
params: params,
|
717
921
|
config: config)
|
718
922
|
context[:gem_name] = 'aws-sdk-pi'
|
719
|
-
context[:gem_version] = '1.
|
923
|
+
context[:gem_version] = '1.37.0'
|
720
924
|
Seahorse::Client::Request.new(handlers, context)
|
721
925
|
end
|
722
926
|
|
@@ -13,21 +13,34 @@ module Aws::PI
|
|
13
13
|
|
14
14
|
include Seahorse::Model
|
15
15
|
|
16
|
+
AdditionalMetricsList = Shapes::ListShape.new(name: 'AdditionalMetricsList')
|
17
|
+
AdditionalMetricsMap = Shapes::MapShape.new(name: 'AdditionalMetricsMap')
|
16
18
|
DataPoint = Shapes::StructureShape.new(name: 'DataPoint')
|
17
19
|
DataPointsList = Shapes::ListShape.new(name: 'DataPointsList')
|
18
20
|
DescribeDimensionKeysRequest = Shapes::StructureShape.new(name: 'DescribeDimensionKeysRequest')
|
19
21
|
DescribeDimensionKeysResponse = Shapes::StructureShape.new(name: 'DescribeDimensionKeysResponse')
|
22
|
+
Description = Shapes::StringShape.new(name: 'Description')
|
20
23
|
DetailStatus = Shapes::StringShape.new(name: 'DetailStatus')
|
24
|
+
DimensionDetail = Shapes::StructureShape.new(name: 'DimensionDetail')
|
25
|
+
DimensionDetailList = Shapes::ListShape.new(name: 'DimensionDetailList')
|
21
26
|
DimensionGroup = Shapes::StructureShape.new(name: 'DimensionGroup')
|
27
|
+
DimensionGroupDetail = Shapes::StructureShape.new(name: 'DimensionGroupDetail')
|
28
|
+
DimensionGroupDetailList = Shapes::ListShape.new(name: 'DimensionGroupDetailList')
|
22
29
|
DimensionKeyDescription = Shapes::StructureShape.new(name: 'DimensionKeyDescription')
|
23
30
|
DimensionKeyDescriptionList = Shapes::ListShape.new(name: 'DimensionKeyDescriptionList')
|
24
31
|
DimensionKeyDetail = Shapes::StructureShape.new(name: 'DimensionKeyDetail')
|
25
32
|
DimensionKeyDetailList = Shapes::ListShape.new(name: 'DimensionKeyDetailList')
|
26
33
|
DimensionMap = Shapes::MapShape.new(name: 'DimensionMap')
|
34
|
+
DimensionsMetricList = Shapes::ListShape.new(name: 'DimensionsMetricList')
|
27
35
|
Double = Shapes::FloatShape.new(name: 'Double')
|
28
36
|
ErrorString = Shapes::StringShape.new(name: 'ErrorString')
|
37
|
+
FeatureMetadata = Shapes::StructureShape.new(name: 'FeatureMetadata')
|
38
|
+
FeatureMetadataMap = Shapes::MapShape.new(name: 'FeatureMetadataMap')
|
39
|
+
FeatureStatus = Shapes::StringShape.new(name: 'FeatureStatus')
|
29
40
|
GetDimensionKeyDetailsRequest = Shapes::StructureShape.new(name: 'GetDimensionKeyDetailsRequest')
|
30
41
|
GetDimensionKeyDetailsResponse = Shapes::StructureShape.new(name: 'GetDimensionKeyDetailsResponse')
|
42
|
+
GetResourceMetadataRequest = Shapes::StructureShape.new(name: 'GetResourceMetadataRequest')
|
43
|
+
GetResourceMetadataResponse = Shapes::StructureShape.new(name: 'GetResourceMetadataResponse')
|
31
44
|
GetResourceMetricsRequest = Shapes::StructureShape.new(name: 'GetResourceMetricsRequest')
|
32
45
|
GetResourceMetricsResponse = Shapes::StructureShape.new(name: 'GetResourceMetricsResponse')
|
33
46
|
ISOTimestamp = Shapes::TimestampShape.new(name: 'ISOTimestamp')
|
@@ -36,12 +49,19 @@ module Aws::PI
|
|
36
49
|
InternalServiceError = Shapes::StructureShape.new(name: 'InternalServiceError')
|
37
50
|
InvalidArgumentException = Shapes::StructureShape.new(name: 'InvalidArgumentException')
|
38
51
|
Limit = Shapes::IntegerShape.new(name: 'Limit')
|
52
|
+
ListAvailableResourceDimensionsRequest = Shapes::StructureShape.new(name: 'ListAvailableResourceDimensionsRequest')
|
53
|
+
ListAvailableResourceDimensionsResponse = Shapes::StructureShape.new(name: 'ListAvailableResourceDimensionsResponse')
|
54
|
+
ListAvailableResourceMetricsRequest = Shapes::StructureShape.new(name: 'ListAvailableResourceMetricsRequest')
|
55
|
+
ListAvailableResourceMetricsResponse = Shapes::StructureShape.new(name: 'ListAvailableResourceMetricsResponse')
|
39
56
|
MaxResults = Shapes::IntegerShape.new(name: 'MaxResults')
|
57
|
+
MetricDimensionGroups = Shapes::StructureShape.new(name: 'MetricDimensionGroups')
|
58
|
+
MetricDimensionsList = Shapes::ListShape.new(name: 'MetricDimensionsList')
|
40
59
|
MetricKeyDataPoints = Shapes::StructureShape.new(name: 'MetricKeyDataPoints')
|
41
60
|
MetricKeyDataPointsList = Shapes::ListShape.new(name: 'MetricKeyDataPointsList')
|
42
61
|
MetricQuery = Shapes::StructureShape.new(name: 'MetricQuery')
|
43
62
|
MetricQueryFilterMap = Shapes::MapShape.new(name: 'MetricQueryFilterMap')
|
44
63
|
MetricQueryList = Shapes::ListShape.new(name: 'MetricQueryList')
|
64
|
+
MetricTypeList = Shapes::ListShape.new(name: 'MetricTypeList')
|
45
65
|
MetricValuesList = Shapes::ListShape.new(name: 'MetricValuesList')
|
46
66
|
NextToken = Shapes::StringShape.new(name: 'NextToken')
|
47
67
|
NotAuthorizedException = Shapes::StructureShape.new(name: 'NotAuthorizedException')
|
@@ -50,10 +70,17 @@ module Aws::PI
|
|
50
70
|
RequestedDimensionList = Shapes::ListShape.new(name: 'RequestedDimensionList')
|
51
71
|
ResponsePartitionKey = Shapes::StructureShape.new(name: 'ResponsePartitionKey')
|
52
72
|
ResponsePartitionKeyList = Shapes::ListShape.new(name: 'ResponsePartitionKeyList')
|
73
|
+
ResponseResourceMetric = Shapes::StructureShape.new(name: 'ResponseResourceMetric')
|
53
74
|
ResponseResourceMetricKey = Shapes::StructureShape.new(name: 'ResponseResourceMetricKey')
|
75
|
+
ResponseResourceMetricList = Shapes::ListShape.new(name: 'ResponseResourceMetricList')
|
54
76
|
ServiceType = Shapes::StringShape.new(name: 'ServiceType')
|
55
77
|
String = Shapes::StringShape.new(name: 'String')
|
56
78
|
|
79
|
+
AdditionalMetricsList.member = Shapes::ShapeRef.new(shape: RequestString)
|
80
|
+
|
81
|
+
AdditionalMetricsMap.key = Shapes::ShapeRef.new(shape: RequestString)
|
82
|
+
AdditionalMetricsMap.value = Shapes::ShapeRef.new(shape: Double)
|
83
|
+
|
57
84
|
DataPoint.add_member(:timestamp, Shapes::ShapeRef.new(shape: ISOTimestamp, required: true, location_name: "Timestamp"))
|
58
85
|
DataPoint.add_member(:value, Shapes::ShapeRef.new(shape: Double, required: true, location_name: "Value"))
|
59
86
|
DataPoint.struct_class = Types::DataPoint
|
@@ -67,6 +94,7 @@ module Aws::PI
|
|
67
94
|
DescribeDimensionKeysRequest.add_member(:metric, Shapes::ShapeRef.new(shape: RequestString, required: true, location_name: "Metric"))
|
68
95
|
DescribeDimensionKeysRequest.add_member(:period_in_seconds, Shapes::ShapeRef.new(shape: Integer, location_name: "PeriodInSeconds"))
|
69
96
|
DescribeDimensionKeysRequest.add_member(:group_by, Shapes::ShapeRef.new(shape: DimensionGroup, required: true, location_name: "GroupBy"))
|
97
|
+
DescribeDimensionKeysRequest.add_member(:additional_metrics, Shapes::ShapeRef.new(shape: AdditionalMetricsList, location_name: "AdditionalMetrics"))
|
70
98
|
DescribeDimensionKeysRequest.add_member(:partition_by, Shapes::ShapeRef.new(shape: DimensionGroup, location_name: "PartitionBy"))
|
71
99
|
DescribeDimensionKeysRequest.add_member(:filter, Shapes::ShapeRef.new(shape: MetricQueryFilterMap, location_name: "Filter"))
|
72
100
|
DescribeDimensionKeysRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxResults, location_name: "MaxResults"))
|
@@ -80,13 +108,25 @@ module Aws::PI
|
|
80
108
|
DescribeDimensionKeysResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "NextToken"))
|
81
109
|
DescribeDimensionKeysResponse.struct_class = Types::DescribeDimensionKeysResponse
|
82
110
|
|
111
|
+
DimensionDetail.add_member(:identifier, Shapes::ShapeRef.new(shape: String, location_name: "Identifier"))
|
112
|
+
DimensionDetail.struct_class = Types::DimensionDetail
|
113
|
+
|
114
|
+
DimensionDetailList.member = Shapes::ShapeRef.new(shape: DimensionDetail)
|
115
|
+
|
83
116
|
DimensionGroup.add_member(:group, Shapes::ShapeRef.new(shape: RequestString, required: true, location_name: "Group"))
|
84
117
|
DimensionGroup.add_member(:dimensions, Shapes::ShapeRef.new(shape: RequestStringList, location_name: "Dimensions"))
|
85
118
|
DimensionGroup.add_member(:limit, Shapes::ShapeRef.new(shape: Limit, location_name: "Limit"))
|
86
119
|
DimensionGroup.struct_class = Types::DimensionGroup
|
87
120
|
|
121
|
+
DimensionGroupDetail.add_member(:group, Shapes::ShapeRef.new(shape: String, location_name: "Group"))
|
122
|
+
DimensionGroupDetail.add_member(:dimensions, Shapes::ShapeRef.new(shape: DimensionDetailList, location_name: "Dimensions"))
|
123
|
+
DimensionGroupDetail.struct_class = Types::DimensionGroupDetail
|
124
|
+
|
125
|
+
DimensionGroupDetailList.member = Shapes::ShapeRef.new(shape: DimensionGroupDetail)
|
126
|
+
|
88
127
|
DimensionKeyDescription.add_member(:dimensions, Shapes::ShapeRef.new(shape: DimensionMap, location_name: "Dimensions"))
|
89
128
|
DimensionKeyDescription.add_member(:total, Shapes::ShapeRef.new(shape: Double, location_name: "Total"))
|
129
|
+
DimensionKeyDescription.add_member(:additional_metrics, Shapes::ShapeRef.new(shape: AdditionalMetricsMap, location_name: "AdditionalMetrics"))
|
90
130
|
DimensionKeyDescription.add_member(:partitions, Shapes::ShapeRef.new(shape: MetricValuesList, location_name: "Partitions"))
|
91
131
|
DimensionKeyDescription.struct_class = Types::DimensionKeyDescription
|
92
132
|
|
@@ -102,6 +142,14 @@ module Aws::PI
|
|
102
142
|
DimensionMap.key = Shapes::ShapeRef.new(shape: RequestString)
|
103
143
|
DimensionMap.value = Shapes::ShapeRef.new(shape: RequestString)
|
104
144
|
|
145
|
+
DimensionsMetricList.member = Shapes::ShapeRef.new(shape: RequestString)
|
146
|
+
|
147
|
+
FeatureMetadata.add_member(:status, Shapes::ShapeRef.new(shape: FeatureStatus, location_name: "Status"))
|
148
|
+
FeatureMetadata.struct_class = Types::FeatureMetadata
|
149
|
+
|
150
|
+
FeatureMetadataMap.key = Shapes::ShapeRef.new(shape: String)
|
151
|
+
FeatureMetadataMap.value = Shapes::ShapeRef.new(shape: FeatureMetadata)
|
152
|
+
|
105
153
|
GetDimensionKeyDetailsRequest.add_member(:service_type, Shapes::ShapeRef.new(shape: ServiceType, required: true, location_name: "ServiceType"))
|
106
154
|
GetDimensionKeyDetailsRequest.add_member(:identifier, Shapes::ShapeRef.new(shape: IdentifierString, required: true, location_name: "Identifier"))
|
107
155
|
GetDimensionKeyDetailsRequest.add_member(:group, Shapes::ShapeRef.new(shape: RequestString, required: true, location_name: "Group"))
|
@@ -112,6 +160,14 @@ module Aws::PI
|
|
112
160
|
GetDimensionKeyDetailsResponse.add_member(:dimensions, Shapes::ShapeRef.new(shape: DimensionKeyDetailList, location_name: "Dimensions"))
|
113
161
|
GetDimensionKeyDetailsResponse.struct_class = Types::GetDimensionKeyDetailsResponse
|
114
162
|
|
163
|
+
GetResourceMetadataRequest.add_member(:service_type, Shapes::ShapeRef.new(shape: ServiceType, required: true, location_name: "ServiceType"))
|
164
|
+
GetResourceMetadataRequest.add_member(:identifier, Shapes::ShapeRef.new(shape: RequestString, required: true, location_name: "Identifier"))
|
165
|
+
GetResourceMetadataRequest.struct_class = Types::GetResourceMetadataRequest
|
166
|
+
|
167
|
+
GetResourceMetadataResponse.add_member(:identifier, Shapes::ShapeRef.new(shape: String, location_name: "Identifier"))
|
168
|
+
GetResourceMetadataResponse.add_member(:features, Shapes::ShapeRef.new(shape: FeatureMetadataMap, location_name: "Features"))
|
169
|
+
GetResourceMetadataResponse.struct_class = Types::GetResourceMetadataResponse
|
170
|
+
|
115
171
|
GetResourceMetricsRequest.add_member(:service_type, Shapes::ShapeRef.new(shape: ServiceType, required: true, location_name: "ServiceType"))
|
116
172
|
GetResourceMetricsRequest.add_member(:identifier, Shapes::ShapeRef.new(shape: RequestString, required: true, location_name: "Identifier"))
|
117
173
|
GetResourceMetricsRequest.add_member(:metric_queries, Shapes::ShapeRef.new(shape: MetricQueryList, required: true, location_name: "MetricQueries"))
|
@@ -135,6 +191,34 @@ module Aws::PI
|
|
135
191
|
InvalidArgumentException.add_member(:message, Shapes::ShapeRef.new(shape: ErrorString, location_name: "Message"))
|
136
192
|
InvalidArgumentException.struct_class = Types::InvalidArgumentException
|
137
193
|
|
194
|
+
ListAvailableResourceDimensionsRequest.add_member(:service_type, Shapes::ShapeRef.new(shape: ServiceType, required: true, location_name: "ServiceType"))
|
195
|
+
ListAvailableResourceDimensionsRequest.add_member(:identifier, Shapes::ShapeRef.new(shape: RequestString, required: true, location_name: "Identifier"))
|
196
|
+
ListAvailableResourceDimensionsRequest.add_member(:metrics, Shapes::ShapeRef.new(shape: DimensionsMetricList, required: true, location_name: "Metrics"))
|
197
|
+
ListAvailableResourceDimensionsRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxResults, location_name: "MaxResults"))
|
198
|
+
ListAvailableResourceDimensionsRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "NextToken"))
|
199
|
+
ListAvailableResourceDimensionsRequest.struct_class = Types::ListAvailableResourceDimensionsRequest
|
200
|
+
|
201
|
+
ListAvailableResourceDimensionsResponse.add_member(:metric_dimensions, Shapes::ShapeRef.new(shape: MetricDimensionsList, location_name: "MetricDimensions"))
|
202
|
+
ListAvailableResourceDimensionsResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "NextToken"))
|
203
|
+
ListAvailableResourceDimensionsResponse.struct_class = Types::ListAvailableResourceDimensionsResponse
|
204
|
+
|
205
|
+
ListAvailableResourceMetricsRequest.add_member(:service_type, Shapes::ShapeRef.new(shape: ServiceType, required: true, location_name: "ServiceType"))
|
206
|
+
ListAvailableResourceMetricsRequest.add_member(:identifier, Shapes::ShapeRef.new(shape: RequestString, required: true, location_name: "Identifier"))
|
207
|
+
ListAvailableResourceMetricsRequest.add_member(:metric_types, Shapes::ShapeRef.new(shape: MetricTypeList, required: true, location_name: "MetricTypes"))
|
208
|
+
ListAvailableResourceMetricsRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "NextToken"))
|
209
|
+
ListAvailableResourceMetricsRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxResults, location_name: "MaxResults"))
|
210
|
+
ListAvailableResourceMetricsRequest.struct_class = Types::ListAvailableResourceMetricsRequest
|
211
|
+
|
212
|
+
ListAvailableResourceMetricsResponse.add_member(:metrics, Shapes::ShapeRef.new(shape: ResponseResourceMetricList, location_name: "Metrics"))
|
213
|
+
ListAvailableResourceMetricsResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "NextToken"))
|
214
|
+
ListAvailableResourceMetricsResponse.struct_class = Types::ListAvailableResourceMetricsResponse
|
215
|
+
|
216
|
+
MetricDimensionGroups.add_member(:metric, Shapes::ShapeRef.new(shape: String, location_name: "Metric"))
|
217
|
+
MetricDimensionGroups.add_member(:groups, Shapes::ShapeRef.new(shape: DimensionGroupDetailList, location_name: "Groups"))
|
218
|
+
MetricDimensionGroups.struct_class = Types::MetricDimensionGroups
|
219
|
+
|
220
|
+
MetricDimensionsList.member = Shapes::ShapeRef.new(shape: MetricDimensionGroups)
|
221
|
+
|
138
222
|
MetricKeyDataPoints.add_member(:key, Shapes::ShapeRef.new(shape: ResponseResourceMetricKey, location_name: "Key"))
|
139
223
|
MetricKeyDataPoints.add_member(:data_points, Shapes::ShapeRef.new(shape: DataPointsList, location_name: "DataPoints"))
|
140
224
|
MetricKeyDataPoints.struct_class = Types::MetricKeyDataPoints
|
@@ -151,6 +235,8 @@ module Aws::PI
|
|
151
235
|
|
152
236
|
MetricQueryList.member = Shapes::ShapeRef.new(shape: MetricQuery)
|
153
237
|
|
238
|
+
MetricTypeList.member = Shapes::ShapeRef.new(shape: RequestString)
|
239
|
+
|
154
240
|
MetricValuesList.member = Shapes::ShapeRef.new(shape: Double)
|
155
241
|
|
156
242
|
NotAuthorizedException.add_member(:message, Shapes::ShapeRef.new(shape: ErrorString, location_name: "Message"))
|
@@ -165,10 +251,17 @@ module Aws::PI
|
|
165
251
|
|
166
252
|
ResponsePartitionKeyList.member = Shapes::ShapeRef.new(shape: ResponsePartitionKey)
|
167
253
|
|
254
|
+
ResponseResourceMetric.add_member(:metric, Shapes::ShapeRef.new(shape: String, location_name: "Metric"))
|
255
|
+
ResponseResourceMetric.add_member(:description, Shapes::ShapeRef.new(shape: Description, location_name: "Description"))
|
256
|
+
ResponseResourceMetric.add_member(:unit, Shapes::ShapeRef.new(shape: String, location_name: "Unit"))
|
257
|
+
ResponseResourceMetric.struct_class = Types::ResponseResourceMetric
|
258
|
+
|
168
259
|
ResponseResourceMetricKey.add_member(:metric, Shapes::ShapeRef.new(shape: String, required: true, location_name: "Metric"))
|
169
260
|
ResponseResourceMetricKey.add_member(:dimensions, Shapes::ShapeRef.new(shape: DimensionMap, location_name: "Dimensions"))
|
170
261
|
ResponseResourceMetricKey.struct_class = Types::ResponseResourceMetricKey
|
171
262
|
|
263
|
+
ResponseResourceMetricList.member = Shapes::ShapeRef.new(shape: ResponseResourceMetric)
|
264
|
+
|
172
265
|
|
173
266
|
# @api private
|
174
267
|
API = Seahorse::Model::Api.new.tap do |api|
|
@@ -198,6 +291,12 @@ module Aws::PI
|
|
198
291
|
o.errors << Shapes::ShapeRef.new(shape: InvalidArgumentException)
|
199
292
|
o.errors << Shapes::ShapeRef.new(shape: InternalServiceError)
|
200
293
|
o.errors << Shapes::ShapeRef.new(shape: NotAuthorizedException)
|
294
|
+
o[:pager] = Aws::Pager.new(
|
295
|
+
limit_key: "max_results",
|
296
|
+
tokens: {
|
297
|
+
"next_token" => "next_token"
|
298
|
+
}
|
299
|
+
)
|
201
300
|
end)
|
202
301
|
|
203
302
|
api.add_operation(:get_dimension_key_details, Seahorse::Model::Operation.new.tap do |o|
|
@@ -211,6 +310,17 @@ module Aws::PI
|
|
211
310
|
o.errors << Shapes::ShapeRef.new(shape: NotAuthorizedException)
|
212
311
|
end)
|
213
312
|
|
313
|
+
api.add_operation(:get_resource_metadata, Seahorse::Model::Operation.new.tap do |o|
|
314
|
+
o.name = "GetResourceMetadata"
|
315
|
+
o.http_method = "POST"
|
316
|
+
o.http_request_uri = "/"
|
317
|
+
o.input = Shapes::ShapeRef.new(shape: GetResourceMetadataRequest)
|
318
|
+
o.output = Shapes::ShapeRef.new(shape: GetResourceMetadataResponse)
|
319
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidArgumentException)
|
320
|
+
o.errors << Shapes::ShapeRef.new(shape: InternalServiceError)
|
321
|
+
o.errors << Shapes::ShapeRef.new(shape: NotAuthorizedException)
|
322
|
+
end)
|
323
|
+
|
214
324
|
api.add_operation(:get_resource_metrics, Seahorse::Model::Operation.new.tap do |o|
|
215
325
|
o.name = "GetResourceMetrics"
|
216
326
|
o.http_method = "POST"
|
@@ -220,6 +330,46 @@ module Aws::PI
|
|
220
330
|
o.errors << Shapes::ShapeRef.new(shape: InvalidArgumentException)
|
221
331
|
o.errors << Shapes::ShapeRef.new(shape: InternalServiceError)
|
222
332
|
o.errors << Shapes::ShapeRef.new(shape: NotAuthorizedException)
|
333
|
+
o[:pager] = Aws::Pager.new(
|
334
|
+
limit_key: "max_results",
|
335
|
+
tokens: {
|
336
|
+
"next_token" => "next_token"
|
337
|
+
}
|
338
|
+
)
|
339
|
+
end)
|
340
|
+
|
341
|
+
api.add_operation(:list_available_resource_dimensions, Seahorse::Model::Operation.new.tap do |o|
|
342
|
+
o.name = "ListAvailableResourceDimensions"
|
343
|
+
o.http_method = "POST"
|
344
|
+
o.http_request_uri = "/"
|
345
|
+
o.input = Shapes::ShapeRef.new(shape: ListAvailableResourceDimensionsRequest)
|
346
|
+
o.output = Shapes::ShapeRef.new(shape: ListAvailableResourceDimensionsResponse)
|
347
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidArgumentException)
|
348
|
+
o.errors << Shapes::ShapeRef.new(shape: InternalServiceError)
|
349
|
+
o.errors << Shapes::ShapeRef.new(shape: NotAuthorizedException)
|
350
|
+
o[:pager] = Aws::Pager.new(
|
351
|
+
limit_key: "max_results",
|
352
|
+
tokens: {
|
353
|
+
"next_token" => "next_token"
|
354
|
+
}
|
355
|
+
)
|
356
|
+
end)
|
357
|
+
|
358
|
+
api.add_operation(:list_available_resource_metrics, Seahorse::Model::Operation.new.tap do |o|
|
359
|
+
o.name = "ListAvailableResourceMetrics"
|
360
|
+
o.http_method = "POST"
|
361
|
+
o.http_request_uri = "/"
|
362
|
+
o.input = Shapes::ShapeRef.new(shape: ListAvailableResourceMetricsRequest)
|
363
|
+
o.output = Shapes::ShapeRef.new(shape: ListAvailableResourceMetricsResponse)
|
364
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidArgumentException)
|
365
|
+
o.errors << Shapes::ShapeRef.new(shape: InternalServiceError)
|
366
|
+
o.errors << Shapes::ShapeRef.new(shape: NotAuthorizedException)
|
367
|
+
o[:pager] = Aws::Pager.new(
|
368
|
+
limit_key: "max_results",
|
369
|
+
tokens: {
|
370
|
+
"next_token" => "next_token"
|
371
|
+
}
|
372
|
+
)
|
223
373
|
end)
|
224
374
|
end
|
225
375
|
|
data/lib/aws-sdk-pi/types.rb
CHANGED
@@ -34,7 +34,7 @@ module Aws::PI
|
|
34
34
|
# data as a hash:
|
35
35
|
#
|
36
36
|
# {
|
37
|
-
# service_type: "RDS", # required, accepts RDS
|
37
|
+
# service_type: "RDS", # required, accepts RDS, DOCDB
|
38
38
|
# identifier: "RequestString", # required
|
39
39
|
# start_time: Time.now, # required
|
40
40
|
# end_time: Time.now, # required
|
@@ -45,6 +45,7 @@ module Aws::PI
|
|
45
45
|
# dimensions: ["RequestString"],
|
46
46
|
# limit: 1,
|
47
47
|
# },
|
48
|
+
# additional_metrics: ["RequestString"],
|
48
49
|
# partition_by: {
|
49
50
|
# group: "RequestString", # required
|
50
51
|
# dimensions: ["RequestString"],
|
@@ -58,17 +59,18 @@ module Aws::PI
|
|
58
59
|
# }
|
59
60
|
#
|
60
61
|
# @!attribute [rw] service_type
|
61
|
-
# The
|
62
|
-
# The only valid value for *ServiceType* is `RDS`.
|
62
|
+
# The Amazon Web Services service for which Performance Insights will
|
63
|
+
# return metrics. The only valid value for *ServiceType* is `RDS`.
|
63
64
|
# @return [String]
|
64
65
|
#
|
65
66
|
# @!attribute [rw] identifier
|
66
|
-
# An immutable,
|
67
|
-
# Performance Insights gathers metrics from this data
|
67
|
+
# An immutable, Amazon Web Services Region-unique identifier for a
|
68
|
+
# data source. Performance Insights gathers metrics from this data
|
69
|
+
# source.
|
68
70
|
#
|
69
71
|
# To use an Amazon RDS instance as a data source, you specify its
|
70
72
|
# `DbiResourceId` value. For example, specify
|
71
|
-
# `db-FAIHNTYBKTGAUSUZQYPDS2GW4A
|
73
|
+
# `db-FAIHNTYBKTGAUSUZQYPDS2GW4A`.
|
72
74
|
# @return [String]
|
73
75
|
#
|
74
76
|
# @!attribute [rw] start_time
|
@@ -140,6 +142,14 @@ module Aws::PI
|
|
140
142
|
# values for a dimension.
|
141
143
|
# @return [Types::DimensionGroup]
|
142
144
|
#
|
145
|
+
# @!attribute [rw] additional_metrics
|
146
|
+
# Additional metrics for the top `N` dimension keys. If the specified
|
147
|
+
# dimension group in the `GroupBy` parameter is `db.sql_tokenized`,
|
148
|
+
# 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" \}`.
|
151
|
+
# @return [Array<String>]
|
152
|
+
#
|
143
153
|
# @!attribute [rw] partition_by
|
144
154
|
# For each dimension specified in `GroupBy`, specify a secondary
|
145
155
|
# dimension to further subdivide the partition keys in the response.
|
@@ -177,6 +187,7 @@ module Aws::PI
|
|
177
187
|
:metric,
|
178
188
|
:period_in_seconds,
|
179
189
|
:group_by,
|
190
|
+
:additional_metrics,
|
180
191
|
:partition_by,
|
181
192
|
:filter,
|
182
193
|
:max_results,
|
@@ -210,9 +221,10 @@ module Aws::PI
|
|
210
221
|
# @return [Array<Types::DimensionKeyDescription>]
|
211
222
|
#
|
212
223
|
# @!attribute [rw] next_token
|
213
|
-
#
|
214
|
-
#
|
215
|
-
#
|
224
|
+
# A pagination token that indicates the response didn’t return all
|
225
|
+
# available records because `MaxRecords` was specified in the previous
|
226
|
+
# request. To get the remaining records, specify `NextToken` in a
|
227
|
+
# separate request with this value.
|
216
228
|
# @return [String]
|
217
229
|
#
|
218
230
|
# @see http://docs.aws.amazon.com/goto/WebAPI/pi-2018-02-27/DescribeDimensionKeysResponse AWS API Documentation
|
@@ -227,6 +239,20 @@ module Aws::PI
|
|
227
239
|
include Aws::Structure
|
228
240
|
end
|
229
241
|
|
242
|
+
# The information about a dimension.
|
243
|
+
#
|
244
|
+
# @!attribute [rw] identifier
|
245
|
+
# The identifier of a dimension.
|
246
|
+
# @return [String]
|
247
|
+
#
|
248
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pi-2018-02-27/DimensionDetail AWS API Documentation
|
249
|
+
#
|
250
|
+
class DimensionDetail < Struct.new(
|
251
|
+
:identifier)
|
252
|
+
SENSITIVE = []
|
253
|
+
include Aws::Structure
|
254
|
+
end
|
255
|
+
|
230
256
|
# A logical grouping of Performance Insights metrics for a related
|
231
257
|
# subject area. For example, the `db.sql` dimension group consists of
|
232
258
|
# the following dimensions: `db.sql.id`, `db.sql.db_id`,
|
@@ -251,8 +277,8 @@ module Aws::PI
|
|
251
277
|
# The name of the dimension group. Valid values are:
|
252
278
|
#
|
253
279
|
# * `db` - The name of the database to which the client is connected
|
254
|
-
# (only Aurora PostgreSQL, RDS PostgreSQL, Aurora MySQL,
|
255
|
-
# and MariaDB)
|
280
|
+
# (only Aurora PostgreSQL, Amazon RDS PostgreSQL, Aurora MySQL,
|
281
|
+
# Amazon RDS MySQL, and MariaDB)
|
256
282
|
#
|
257
283
|
# * `db.application` - The name of the application that is connected
|
258
284
|
# to the database (only Aurora PostgreSQL and RDS PostgreSQL)
|
@@ -293,8 +319,8 @@ module Aws::PI
|
|
293
319
|
# engines)
|
294
320
|
#
|
295
321
|
# * `db.name` - The name of the database to which the client is
|
296
|
-
# connected (only Aurora PostgreSQL, RDS PostgreSQL, Aurora
|
297
|
-
# RDS MySQL, and MariaDB)
|
322
|
+
# connected (only Aurora PostgreSQL, Amazon RDS PostgreSQL, Aurora
|
323
|
+
# MySQL, Amazon RDS MySQL, and MariaDB)
|
298
324
|
#
|
299
325
|
# * `db.session_type.name` - The type of the current session (only
|
300
326
|
# Aurora PostgreSQL and RDS PostgreSQL)
|
@@ -348,18 +374,41 @@ module Aws::PI
|
|
348
374
|
include Aws::Structure
|
349
375
|
end
|
350
376
|
|
351
|
-
#
|
352
|
-
#
|
377
|
+
# Information about dimensions within a dimension group.
|
378
|
+
#
|
379
|
+
# @!attribute [rw] group
|
380
|
+
# The name of the dimension group.
|
381
|
+
# @return [String]
|
382
|
+
#
|
383
|
+
# @!attribute [rw] dimensions
|
384
|
+
# The dimensions within a dimension group.
|
385
|
+
# @return [Array<Types::DimensionDetail>]
|
386
|
+
#
|
387
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pi-2018-02-27/DimensionGroupDetail AWS API Documentation
|
388
|
+
#
|
389
|
+
class DimensionGroupDetail < Struct.new(
|
390
|
+
:group,
|
391
|
+
:dimensions)
|
392
|
+
SENSITIVE = []
|
393
|
+
include Aws::Structure
|
394
|
+
end
|
395
|
+
|
396
|
+
# An object that includes the requested dimension key values and
|
397
|
+
# aggregated metric values within a dimension group.
|
353
398
|
#
|
354
399
|
# @!attribute [rw] dimensions
|
355
400
|
# A map of name-value pairs for the dimensions in the group.
|
356
401
|
# @return [Hash<String,String>]
|
357
402
|
#
|
358
403
|
# @!attribute [rw] total
|
359
|
-
# The aggregated metric value for the
|
404
|
+
# The aggregated metric value for the dimensions, over the requested
|
360
405
|
# time range.
|
361
406
|
# @return [Float]
|
362
407
|
#
|
408
|
+
# @!attribute [rw] additional_metrics
|
409
|
+
# A map that contains the value for each additional metric.
|
410
|
+
# @return [Hash<String,Float>]
|
411
|
+
#
|
363
412
|
# @!attribute [rw] partitions
|
364
413
|
# If `PartitionBy` was specified, `PartitionKeys` contains the
|
365
414
|
# dimensions that were.
|
@@ -370,6 +419,7 @@ module Aws::PI
|
|
370
419
|
class DimensionKeyDescription < Struct.new(
|
371
420
|
:dimensions,
|
372
421
|
:total,
|
422
|
+
:additional_metrics,
|
373
423
|
:partitions)
|
374
424
|
SENSITIVE = []
|
375
425
|
include Aws::Structure
|
@@ -413,11 +463,41 @@ module Aws::PI
|
|
413
463
|
include Aws::Structure
|
414
464
|
end
|
415
465
|
|
466
|
+
# The metadata for a feature. For example, the metadata might indicate
|
467
|
+
# that a feature is turned on or off on a specific DB instance.
|
468
|
+
#
|
469
|
+
# @!attribute [rw] status
|
470
|
+
# The status of the feature on the DB instance. Possible values
|
471
|
+
# include the following:
|
472
|
+
#
|
473
|
+
# * `ENABLED`\: the feature is enabled on the instance.
|
474
|
+
#
|
475
|
+
# * `DISABLED`\: the feature is disabled on the instance.
|
476
|
+
#
|
477
|
+
# * `UNSUPPORTED`\: the feature isn't supported on the instance.
|
478
|
+
#
|
479
|
+
# * `ENABLED_PENDING_REBOOT`\: the feature is enabled on the instance
|
480
|
+
# but requires a reboot to take effect.
|
481
|
+
#
|
482
|
+
# * `DISABLED_PENDING_REBOOT`\: the feature is disabled on the
|
483
|
+
# instance but requires a reboot to take effect.
|
484
|
+
#
|
485
|
+
# * `UNKNOWN`\: the feature status couldn't be determined.
|
486
|
+
# @return [String]
|
487
|
+
#
|
488
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pi-2018-02-27/FeatureMetadata AWS API Documentation
|
489
|
+
#
|
490
|
+
class FeatureMetadata < Struct.new(
|
491
|
+
:status)
|
492
|
+
SENSITIVE = []
|
493
|
+
include Aws::Structure
|
494
|
+
end
|
495
|
+
|
416
496
|
# @note When making an API call, you may pass GetDimensionKeyDetailsRequest
|
417
497
|
# data as a hash:
|
418
498
|
#
|
419
499
|
# {
|
420
|
-
# service_type: "RDS", # required, accepts RDS
|
500
|
+
# service_type: "RDS", # required, accepts RDS, DOCDB
|
421
501
|
# identifier: "IdentifierString", # required
|
422
502
|
# group: "RequestString", # required
|
423
503
|
# group_identifier: "RequestString", # required
|
@@ -425,15 +505,16 @@ module Aws::PI
|
|
425
505
|
# }
|
426
506
|
#
|
427
507
|
# @!attribute [rw] service_type
|
428
|
-
# The
|
429
|
-
# only valid value is `RDS`.
|
508
|
+
# The Amazon Web Services service for which Performance Insights
|
509
|
+
# returns data. The only valid value is `RDS`.
|
430
510
|
# @return [String]
|
431
511
|
#
|
432
512
|
# @!attribute [rw] identifier
|
433
513
|
# The ID for a data source from which to gather dimension data. This
|
434
|
-
# ID must be immutable and unique within an
|
435
|
-
# instance is the data source, specify its
|
436
|
-
# example, specify
|
514
|
+
# ID must be immutable and unique within an Amazon Web Services
|
515
|
+
# Region. When a DB instance is the data source, specify its
|
516
|
+
# `DbiResourceId` value. For example, specify
|
517
|
+
# `db-ABCDEFGHIJKLMNOPQRSTU1VW2X`.
|
437
518
|
# @return [String]
|
438
519
|
#
|
439
520
|
# @!attribute [rw] group
|
@@ -480,11 +561,64 @@ module Aws::PI
|
|
480
561
|
include Aws::Structure
|
481
562
|
end
|
482
563
|
|
564
|
+
# @note When making an API call, you may pass GetResourceMetadataRequest
|
565
|
+
# data as a hash:
|
566
|
+
#
|
567
|
+
# {
|
568
|
+
# service_type: "RDS", # required, accepts RDS, DOCDB
|
569
|
+
# identifier: "RequestString", # required
|
570
|
+
# }
|
571
|
+
#
|
572
|
+
# @!attribute [rw] service_type
|
573
|
+
# The Amazon Web Services service for which Performance Insights
|
574
|
+
# returns metrics.
|
575
|
+
# @return [String]
|
576
|
+
#
|
577
|
+
# @!attribute [rw] identifier
|
578
|
+
# An immutable identifier for a data source that is unique for an
|
579
|
+
# Amazon Web Services Region. Performance Insights gathers metrics
|
580
|
+
# from this data source. To use a DB instance as a data source,
|
581
|
+
# specify its `DbiResourceId` value. For example, specify
|
582
|
+
# `db-ABCDEFGHIJKLMNOPQRSTU1VW2X`.
|
583
|
+
# @return [String]
|
584
|
+
#
|
585
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pi-2018-02-27/GetResourceMetadataRequest AWS API Documentation
|
586
|
+
#
|
587
|
+
class GetResourceMetadataRequest < Struct.new(
|
588
|
+
:service_type,
|
589
|
+
:identifier)
|
590
|
+
SENSITIVE = []
|
591
|
+
include Aws::Structure
|
592
|
+
end
|
593
|
+
|
594
|
+
# @!attribute [rw] identifier
|
595
|
+
# An immutable identifier for a data source that is unique for an
|
596
|
+
# Amazon Web Services Region. Performance Insights gathers metrics
|
597
|
+
# from this data source. To use a DB instance as a data source,
|
598
|
+
# specify its `DbiResourceId` value. For example, specify
|
599
|
+
# `db-ABCDEFGHIJKLMNOPQRSTU1VW2X`.
|
600
|
+
# @return [String]
|
601
|
+
#
|
602
|
+
# @!attribute [rw] features
|
603
|
+
# The metadata for different features. For example, the metadata might
|
604
|
+
# indicate that a feature is turned on or off on a specific DB
|
605
|
+
# instance.
|
606
|
+
# @return [Hash<String,Types::FeatureMetadata>]
|
607
|
+
#
|
608
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pi-2018-02-27/GetResourceMetadataResponse AWS API Documentation
|
609
|
+
#
|
610
|
+
class GetResourceMetadataResponse < Struct.new(
|
611
|
+
:identifier,
|
612
|
+
:features)
|
613
|
+
SENSITIVE = []
|
614
|
+
include Aws::Structure
|
615
|
+
end
|
616
|
+
|
483
617
|
# @note When making an API call, you may pass GetResourceMetricsRequest
|
484
618
|
# data as a hash:
|
485
619
|
#
|
486
620
|
# {
|
487
|
-
# service_type: "RDS", # required, accepts RDS
|
621
|
+
# service_type: "RDS", # required, accepts RDS, DOCDB
|
488
622
|
# identifier: "RequestString", # required
|
489
623
|
# metric_queries: [ # required
|
490
624
|
# {
|
@@ -507,13 +641,14 @@ module Aws::PI
|
|
507
641
|
# }
|
508
642
|
#
|
509
643
|
# @!attribute [rw] service_type
|
510
|
-
# The
|
511
|
-
# only valid value for *ServiceType* is `RDS`.
|
644
|
+
# The Amazon Web Services service for which Performance Insights
|
645
|
+
# returns metrics. The only valid value for *ServiceType* is `RDS`.
|
512
646
|
# @return [String]
|
513
647
|
#
|
514
648
|
# @!attribute [rw] identifier
|
515
|
-
# An immutable,
|
516
|
-
# Performance Insights gathers metrics from this data
|
649
|
+
# An immutable, Amazon Web Services Region-unique identifier for a
|
650
|
+
# data source. Performance Insights gathers metrics from this data
|
651
|
+
# source.
|
517
652
|
#
|
518
653
|
# To use a DB instance as a data source, specify its `DbiResourceId`
|
519
654
|
# value. For example, specify `db-FAIHNTYBKTGAUSUZQYPDS2GW4A`.
|
@@ -607,8 +742,9 @@ module Aws::PI
|
|
607
742
|
# @return [Time]
|
608
743
|
#
|
609
744
|
# @!attribute [rw] identifier
|
610
|
-
# An immutable,
|
611
|
-
# Performance Insights gathers metrics from this data
|
745
|
+
# An immutable, Amazon Web Services Region-unique identifier for a
|
746
|
+
# data source. Performance Insights gathers metrics from this data
|
747
|
+
# source.
|
612
748
|
#
|
613
749
|
# To use a DB instance as a data source, you specify its
|
614
750
|
# `DbiResourceId` value - for example: `db-FAIHNTYBKTGAUSUZQYPDS2GW4A`
|
@@ -663,11 +799,185 @@ module Aws::PI
|
|
663
799
|
include Aws::Structure
|
664
800
|
end
|
665
801
|
|
802
|
+
# @note When making an API call, you may pass ListAvailableResourceDimensionsRequest
|
803
|
+
# data as a hash:
|
804
|
+
#
|
805
|
+
# {
|
806
|
+
# service_type: "RDS", # required, accepts RDS, DOCDB
|
807
|
+
# identifier: "RequestString", # required
|
808
|
+
# metrics: ["RequestString"], # required
|
809
|
+
# max_results: 1,
|
810
|
+
# next_token: "NextToken",
|
811
|
+
# }
|
812
|
+
#
|
813
|
+
# @!attribute [rw] service_type
|
814
|
+
# The Amazon Web Services service for which Performance Insights
|
815
|
+
# returns metrics.
|
816
|
+
# @return [String]
|
817
|
+
#
|
818
|
+
# @!attribute [rw] identifier
|
819
|
+
# An immutable identifier for a data source that is unique within an
|
820
|
+
# Amazon Web Services Region. Performance Insights gathers metrics
|
821
|
+
# from this data source. To use an Amazon RDS DB instance as a data
|
822
|
+
# source, specify its `DbiResourceId` value. For example, specify
|
823
|
+
# `db-ABCDEFGHIJKLMNOPQRSTU1VWZ`.
|
824
|
+
# @return [String]
|
825
|
+
#
|
826
|
+
# @!attribute [rw] metrics
|
827
|
+
# The types of metrics for which to retrieve dimensions. Valid values
|
828
|
+
# include `db.load`.
|
829
|
+
# @return [Array<String>]
|
830
|
+
#
|
831
|
+
# @!attribute [rw] max_results
|
832
|
+
# The maximum number of items to return in the response. If more items
|
833
|
+
# exist than the specified `MaxRecords` value, a pagination token is
|
834
|
+
# included in the response so that the remaining results can be
|
835
|
+
# retrieved.
|
836
|
+
# @return [Integer]
|
837
|
+
#
|
838
|
+
# @!attribute [rw] next_token
|
839
|
+
# An optional pagination token provided by a previous request. If this
|
840
|
+
# parameter is specified, the response includes only records beyond
|
841
|
+
# the token, up to the value specified by `MaxRecords`.
|
842
|
+
# @return [String]
|
843
|
+
#
|
844
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pi-2018-02-27/ListAvailableResourceDimensionsRequest AWS API Documentation
|
845
|
+
#
|
846
|
+
class ListAvailableResourceDimensionsRequest < Struct.new(
|
847
|
+
:service_type,
|
848
|
+
:identifier,
|
849
|
+
:metrics,
|
850
|
+
:max_results,
|
851
|
+
:next_token)
|
852
|
+
SENSITIVE = []
|
853
|
+
include Aws::Structure
|
854
|
+
end
|
855
|
+
|
856
|
+
# @!attribute [rw] metric_dimensions
|
857
|
+
# The dimension information returned for requested metric types.
|
858
|
+
# @return [Array<Types::MetricDimensionGroups>]
|
859
|
+
#
|
860
|
+
# @!attribute [rw] next_token
|
861
|
+
# An optional pagination token provided by a previous request. If this
|
862
|
+
# parameter is specified, the response includes only records beyond
|
863
|
+
# the token, up to the value specified by `MaxRecords`.
|
864
|
+
# @return [String]
|
865
|
+
#
|
866
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pi-2018-02-27/ListAvailableResourceDimensionsResponse AWS API Documentation
|
867
|
+
#
|
868
|
+
class ListAvailableResourceDimensionsResponse < Struct.new(
|
869
|
+
:metric_dimensions,
|
870
|
+
:next_token)
|
871
|
+
SENSITIVE = []
|
872
|
+
include Aws::Structure
|
873
|
+
end
|
874
|
+
|
875
|
+
# @note When making an API call, you may pass ListAvailableResourceMetricsRequest
|
876
|
+
# data as a hash:
|
877
|
+
#
|
878
|
+
# {
|
879
|
+
# service_type: "RDS", # required, accepts RDS, DOCDB
|
880
|
+
# identifier: "RequestString", # required
|
881
|
+
# metric_types: ["RequestString"], # required
|
882
|
+
# next_token: "NextToken",
|
883
|
+
# max_results: 1,
|
884
|
+
# }
|
885
|
+
#
|
886
|
+
# @!attribute [rw] service_type
|
887
|
+
# The Amazon Web Services service for which Performance Insights
|
888
|
+
# returns metrics.
|
889
|
+
# @return [String]
|
890
|
+
#
|
891
|
+
# @!attribute [rw] identifier
|
892
|
+
# An immutable identifier for a data source that is unique within an
|
893
|
+
# Amazon Web Services Region. Performance Insights gathers metrics
|
894
|
+
# from this data source. To use an Amazon RDS DB instance as a data
|
895
|
+
# source, specify its `DbiResourceId` value. For example, specify
|
896
|
+
# `db-ABCDEFGHIJKLMNOPQRSTU1VWZ`.
|
897
|
+
# @return [String]
|
898
|
+
#
|
899
|
+
# @!attribute [rw] metric_types
|
900
|
+
# The types of metrics to return in the response. Valid values in the
|
901
|
+
# array include the following:
|
902
|
+
#
|
903
|
+
# * `os` (OS counter metrics)
|
904
|
+
#
|
905
|
+
# * `db` (DB load metrics)
|
906
|
+
#
|
907
|
+
# * `db.sql.stats` (per-SQL metrics)
|
908
|
+
#
|
909
|
+
# * `db.sql_tokenized.stats` (per-SQL digest metrics)
|
910
|
+
# @return [Array<String>]
|
911
|
+
#
|
912
|
+
# @!attribute [rw] next_token
|
913
|
+
# An optional pagination token provided by a previous request. If this
|
914
|
+
# parameter is specified, the response includes only records beyond
|
915
|
+
# the token, up to the value specified by `MaxRecords`.
|
916
|
+
# @return [String]
|
917
|
+
#
|
918
|
+
# @!attribute [rw] max_results
|
919
|
+
# The maximum number of items to return. If the `MaxRecords` value is
|
920
|
+
# less than the number of existing items, the response includes a
|
921
|
+
# pagination token.
|
922
|
+
# @return [Integer]
|
923
|
+
#
|
924
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pi-2018-02-27/ListAvailableResourceMetricsRequest AWS API Documentation
|
925
|
+
#
|
926
|
+
class ListAvailableResourceMetricsRequest < Struct.new(
|
927
|
+
:service_type,
|
928
|
+
:identifier,
|
929
|
+
:metric_types,
|
930
|
+
:next_token,
|
931
|
+
:max_results)
|
932
|
+
SENSITIVE = []
|
933
|
+
include Aws::Structure
|
934
|
+
end
|
935
|
+
|
936
|
+
# @!attribute [rw] metrics
|
937
|
+
# An array of metrics available to query. Each array element contains
|
938
|
+
# the full name, description, and unit of the metric.
|
939
|
+
# @return [Array<Types::ResponseResourceMetric>]
|
940
|
+
#
|
941
|
+
# @!attribute [rw] next_token
|
942
|
+
# A pagination token that indicates the response didn’t return all
|
943
|
+
# available records because `MaxRecords` was specified in the previous
|
944
|
+
# request. To get the remaining records, specify `NextToken` in a
|
945
|
+
# separate request with this value.
|
946
|
+
# @return [String]
|
947
|
+
#
|
948
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pi-2018-02-27/ListAvailableResourceMetricsResponse AWS API Documentation
|
949
|
+
#
|
950
|
+
class ListAvailableResourceMetricsResponse < Struct.new(
|
951
|
+
:metrics,
|
952
|
+
:next_token)
|
953
|
+
SENSITIVE = []
|
954
|
+
include Aws::Structure
|
955
|
+
end
|
956
|
+
|
957
|
+
# The available dimension information for a metric type.
|
958
|
+
#
|
959
|
+
# @!attribute [rw] metric
|
960
|
+
# The metric type to which the dimension information belongs.
|
961
|
+
# @return [String]
|
962
|
+
#
|
963
|
+
# @!attribute [rw] groups
|
964
|
+
# The available dimension groups for a metric type.
|
965
|
+
# @return [Array<Types::DimensionGroupDetail>]
|
966
|
+
#
|
967
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pi-2018-02-27/MetricDimensionGroups AWS API Documentation
|
968
|
+
#
|
969
|
+
class MetricDimensionGroups < Struct.new(
|
970
|
+
:metric,
|
971
|
+
:groups)
|
972
|
+
SENSITIVE = []
|
973
|
+
include Aws::Structure
|
974
|
+
end
|
975
|
+
|
666
976
|
# A time-ordered series of data points, corresponding to a dimension of
|
667
977
|
# a Performance Insights metric.
|
668
978
|
#
|
669
979
|
# @!attribute [rw] key
|
670
|
-
# The
|
980
|
+
# The dimensions to which the data points apply.
|
671
981
|
# @return [Types::ResponseResourceMetricKey]
|
672
982
|
#
|
673
983
|
# @!attribute [rw] data_points
|
@@ -686,8 +996,8 @@ module Aws::PI
|
|
686
996
|
|
687
997
|
# A single query to be processed. You must provide the metric to query.
|
688
998
|
# If no other parameters are specified, Performance Insights returns all
|
689
|
-
#
|
690
|
-
# the data points be aggregated by dimension group (
|
999
|
+
# data points for the specified metric. Optionally, you can request that
|
1000
|
+
# the data points be aggregated by dimension group (`GroupBy`), and
|
691
1001
|
# return only those data points that match your criteria (`Filter`).
|
692
1002
|
#
|
693
1003
|
# @note When making an API call, you may pass MetricQuery
|
@@ -772,7 +1082,7 @@ module Aws::PI
|
|
772
1082
|
# specifies one dimension.
|
773
1083
|
#
|
774
1084
|
# @!attribute [rw] dimensions
|
775
|
-
# A dimension map that contains the
|
1085
|
+
# A dimension map that contains the dimensions for this partition.
|
776
1086
|
# @return [Hash<String,String>]
|
777
1087
|
#
|
778
1088
|
# @see http://docs.aws.amazon.com/goto/WebAPI/pi-2018-02-27/ResponsePartitionKey AWS API Documentation
|
@@ -783,6 +1093,31 @@ module Aws::PI
|
|
783
1093
|
include Aws::Structure
|
784
1094
|
end
|
785
1095
|
|
1096
|
+
# An object that contains the full name, description, and unit of a
|
1097
|
+
# metric.
|
1098
|
+
#
|
1099
|
+
# @!attribute [rw] metric
|
1100
|
+
# The full name of the metric.
|
1101
|
+
# @return [String]
|
1102
|
+
#
|
1103
|
+
# @!attribute [rw] description
|
1104
|
+
# The description of the metric.
|
1105
|
+
# @return [String]
|
1106
|
+
#
|
1107
|
+
# @!attribute [rw] unit
|
1108
|
+
# The unit of the metric.
|
1109
|
+
# @return [String]
|
1110
|
+
#
|
1111
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pi-2018-02-27/ResponseResourceMetric AWS API Documentation
|
1112
|
+
#
|
1113
|
+
class ResponseResourceMetric < Struct.new(
|
1114
|
+
:metric,
|
1115
|
+
:description,
|
1116
|
+
:unit)
|
1117
|
+
SENSITIVE = []
|
1118
|
+
include Aws::Structure
|
1119
|
+
end
|
1120
|
+
|
786
1121
|
# An object describing a Performance Insights metric and one or more
|
787
1122
|
# dimensions for that metric.
|
788
1123
|
#
|
data/lib/aws-sdk-pi.rb
CHANGED
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.
|
4
|
+
version: 1.37.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:
|
11
|
+
date: 2022-02-03 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.
|
22
|
+
version: 3.126.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.
|
32
|
+
version: 3.126.0
|
33
33
|
- !ruby/object:Gem::Dependency
|
34
34
|
name: aws-sigv4
|
35
35
|
requirement: !ruby/object:Gem::Requirement
|