aws-sdk-pi 1.23.0 → 1.28.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 +153 -0
- data/LICENSE.txt +202 -0
- data/VERSION +1 -0
- data/lib/aws-sdk-pi.rb +2 -2
- data/lib/aws-sdk-pi/client.rb +122 -37
- data/lib/aws-sdk-pi/client_api.rb +61 -21
- data/lib/aws-sdk-pi/errors.rb +1 -1
- data/lib/aws-sdk-pi/resource.rb +1 -1
- data/lib/aws-sdk-pi/types.rb +234 -61
- metadata +11 -9
@@ -3,7 +3,7 @@
|
|
3
3
|
# WARNING ABOUT GENERATED CODE
|
4
4
|
#
|
5
5
|
# This file is generated. See the contributing guide for more information:
|
6
|
-
# https://github.com/aws/aws-sdk-ruby/blob/
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
7
7
|
#
|
8
8
|
# WARNING ABOUT GENERATED CODE
|
9
9
|
|
@@ -17,14 +17,21 @@ module Aws::PI
|
|
17
17
|
DataPointsList = Shapes::ListShape.new(name: 'DataPointsList')
|
18
18
|
DescribeDimensionKeysRequest = Shapes::StructureShape.new(name: 'DescribeDimensionKeysRequest')
|
19
19
|
DescribeDimensionKeysResponse = Shapes::StructureShape.new(name: 'DescribeDimensionKeysResponse')
|
20
|
+
DetailStatus = Shapes::StringShape.new(name: 'DetailStatus')
|
20
21
|
DimensionGroup = Shapes::StructureShape.new(name: 'DimensionGroup')
|
21
22
|
DimensionKeyDescription = Shapes::StructureShape.new(name: 'DimensionKeyDescription')
|
22
23
|
DimensionKeyDescriptionList = Shapes::ListShape.new(name: 'DimensionKeyDescriptionList')
|
24
|
+
DimensionKeyDetail = Shapes::StructureShape.new(name: 'DimensionKeyDetail')
|
25
|
+
DimensionKeyDetailList = Shapes::ListShape.new(name: 'DimensionKeyDetailList')
|
23
26
|
DimensionMap = Shapes::MapShape.new(name: 'DimensionMap')
|
24
27
|
Double = Shapes::FloatShape.new(name: 'Double')
|
28
|
+
ErrorString = Shapes::StringShape.new(name: 'ErrorString')
|
29
|
+
GetDimensionKeyDetailsRequest = Shapes::StructureShape.new(name: 'GetDimensionKeyDetailsRequest')
|
30
|
+
GetDimensionKeyDetailsResponse = Shapes::StructureShape.new(name: 'GetDimensionKeyDetailsResponse')
|
25
31
|
GetResourceMetricsRequest = Shapes::StructureShape.new(name: 'GetResourceMetricsRequest')
|
26
32
|
GetResourceMetricsResponse = Shapes::StructureShape.new(name: 'GetResourceMetricsResponse')
|
27
33
|
ISOTimestamp = Shapes::TimestampShape.new(name: 'ISOTimestamp')
|
34
|
+
IdentifierString = Shapes::StringShape.new(name: 'IdentifierString')
|
28
35
|
Integer = Shapes::IntegerShape.new(name: 'Integer')
|
29
36
|
InternalServiceError = Shapes::StructureShape.new(name: 'InternalServiceError')
|
30
37
|
InvalidArgumentException = Shapes::StructureShape.new(name: 'InvalidArgumentException')
|
@@ -36,13 +43,16 @@ module Aws::PI
|
|
36
43
|
MetricQueryFilterMap = Shapes::MapShape.new(name: 'MetricQueryFilterMap')
|
37
44
|
MetricQueryList = Shapes::ListShape.new(name: 'MetricQueryList')
|
38
45
|
MetricValuesList = Shapes::ListShape.new(name: 'MetricValuesList')
|
46
|
+
NextToken = Shapes::StringShape.new(name: 'NextToken')
|
39
47
|
NotAuthorizedException = Shapes::StructureShape.new(name: 'NotAuthorizedException')
|
48
|
+
RequestString = Shapes::StringShape.new(name: 'RequestString')
|
49
|
+
RequestStringList = Shapes::ListShape.new(name: 'RequestStringList')
|
50
|
+
RequestedDimensionList = Shapes::ListShape.new(name: 'RequestedDimensionList')
|
40
51
|
ResponsePartitionKey = Shapes::StructureShape.new(name: 'ResponsePartitionKey')
|
41
52
|
ResponsePartitionKeyList = Shapes::ListShape.new(name: 'ResponsePartitionKeyList')
|
42
53
|
ResponseResourceMetricKey = Shapes::StructureShape.new(name: 'ResponseResourceMetricKey')
|
43
54
|
ServiceType = Shapes::StringShape.new(name: 'ServiceType')
|
44
55
|
String = Shapes::StringShape.new(name: 'String')
|
45
|
-
StringList = Shapes::ListShape.new(name: 'StringList')
|
46
56
|
|
47
57
|
DataPoint.add_member(:timestamp, Shapes::ShapeRef.new(shape: ISOTimestamp, required: true, location_name: "Timestamp"))
|
48
58
|
DataPoint.add_member(:value, Shapes::ShapeRef.new(shape: Double, required: true, location_name: "Value"))
|
@@ -51,27 +61,27 @@ module Aws::PI
|
|
51
61
|
DataPointsList.member = Shapes::ShapeRef.new(shape: DataPoint)
|
52
62
|
|
53
63
|
DescribeDimensionKeysRequest.add_member(:service_type, Shapes::ShapeRef.new(shape: ServiceType, required: true, location_name: "ServiceType"))
|
54
|
-
DescribeDimensionKeysRequest.add_member(:identifier, Shapes::ShapeRef.new(shape:
|
64
|
+
DescribeDimensionKeysRequest.add_member(:identifier, Shapes::ShapeRef.new(shape: RequestString, required: true, location_name: "Identifier"))
|
55
65
|
DescribeDimensionKeysRequest.add_member(:start_time, Shapes::ShapeRef.new(shape: ISOTimestamp, required: true, location_name: "StartTime"))
|
56
66
|
DescribeDimensionKeysRequest.add_member(:end_time, Shapes::ShapeRef.new(shape: ISOTimestamp, required: true, location_name: "EndTime"))
|
57
|
-
DescribeDimensionKeysRequest.add_member(:metric, Shapes::ShapeRef.new(shape:
|
67
|
+
DescribeDimensionKeysRequest.add_member(:metric, Shapes::ShapeRef.new(shape: RequestString, required: true, location_name: "Metric"))
|
58
68
|
DescribeDimensionKeysRequest.add_member(:period_in_seconds, Shapes::ShapeRef.new(shape: Integer, location_name: "PeriodInSeconds"))
|
59
69
|
DescribeDimensionKeysRequest.add_member(:group_by, Shapes::ShapeRef.new(shape: DimensionGroup, required: true, location_name: "GroupBy"))
|
60
70
|
DescribeDimensionKeysRequest.add_member(:partition_by, Shapes::ShapeRef.new(shape: DimensionGroup, location_name: "PartitionBy"))
|
61
71
|
DescribeDimensionKeysRequest.add_member(:filter, Shapes::ShapeRef.new(shape: MetricQueryFilterMap, location_name: "Filter"))
|
62
72
|
DescribeDimensionKeysRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxResults, location_name: "MaxResults"))
|
63
|
-
DescribeDimensionKeysRequest.add_member(:next_token, Shapes::ShapeRef.new(shape:
|
73
|
+
DescribeDimensionKeysRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "NextToken"))
|
64
74
|
DescribeDimensionKeysRequest.struct_class = Types::DescribeDimensionKeysRequest
|
65
75
|
|
66
76
|
DescribeDimensionKeysResponse.add_member(:aligned_start_time, Shapes::ShapeRef.new(shape: ISOTimestamp, location_name: "AlignedStartTime"))
|
67
77
|
DescribeDimensionKeysResponse.add_member(:aligned_end_time, Shapes::ShapeRef.new(shape: ISOTimestamp, location_name: "AlignedEndTime"))
|
68
78
|
DescribeDimensionKeysResponse.add_member(:partition_keys, Shapes::ShapeRef.new(shape: ResponsePartitionKeyList, location_name: "PartitionKeys"))
|
69
79
|
DescribeDimensionKeysResponse.add_member(:keys, Shapes::ShapeRef.new(shape: DimensionKeyDescriptionList, location_name: "Keys"))
|
70
|
-
DescribeDimensionKeysResponse.add_member(:next_token, Shapes::ShapeRef.new(shape:
|
80
|
+
DescribeDimensionKeysResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "NextToken"))
|
71
81
|
DescribeDimensionKeysResponse.struct_class = Types::DescribeDimensionKeysResponse
|
72
82
|
|
73
|
-
DimensionGroup.add_member(:group, Shapes::ShapeRef.new(shape:
|
74
|
-
DimensionGroup.add_member(:dimensions, Shapes::ShapeRef.new(shape:
|
83
|
+
DimensionGroup.add_member(:group, Shapes::ShapeRef.new(shape: RequestString, required: true, location_name: "Group"))
|
84
|
+
DimensionGroup.add_member(:dimensions, Shapes::ShapeRef.new(shape: RequestStringList, location_name: "Dimensions"))
|
75
85
|
DimensionGroup.add_member(:limit, Shapes::ShapeRef.new(shape: Limit, location_name: "Limit"))
|
76
86
|
DimensionGroup.struct_class = Types::DimensionGroup
|
77
87
|
|
@@ -82,30 +92,47 @@ module Aws::PI
|
|
82
92
|
|
83
93
|
DimensionKeyDescriptionList.member = Shapes::ShapeRef.new(shape: DimensionKeyDescription)
|
84
94
|
|
85
|
-
|
86
|
-
|
95
|
+
DimensionKeyDetail.add_member(:value, Shapes::ShapeRef.new(shape: String, location_name: "Value"))
|
96
|
+
DimensionKeyDetail.add_member(:dimension, Shapes::ShapeRef.new(shape: String, location_name: "Dimension"))
|
97
|
+
DimensionKeyDetail.add_member(:status, Shapes::ShapeRef.new(shape: DetailStatus, location_name: "Status"))
|
98
|
+
DimensionKeyDetail.struct_class = Types::DimensionKeyDetail
|
99
|
+
|
100
|
+
DimensionKeyDetailList.member = Shapes::ShapeRef.new(shape: DimensionKeyDetail)
|
101
|
+
|
102
|
+
DimensionMap.key = Shapes::ShapeRef.new(shape: RequestString)
|
103
|
+
DimensionMap.value = Shapes::ShapeRef.new(shape: RequestString)
|
104
|
+
|
105
|
+
GetDimensionKeyDetailsRequest.add_member(:service_type, Shapes::ShapeRef.new(shape: ServiceType, required: true, location_name: "ServiceType"))
|
106
|
+
GetDimensionKeyDetailsRequest.add_member(:identifier, Shapes::ShapeRef.new(shape: IdentifierString, required: true, location_name: "Identifier"))
|
107
|
+
GetDimensionKeyDetailsRequest.add_member(:group, Shapes::ShapeRef.new(shape: RequestString, required: true, location_name: "Group"))
|
108
|
+
GetDimensionKeyDetailsRequest.add_member(:group_identifier, Shapes::ShapeRef.new(shape: RequestString, required: true, location_name: "GroupIdentifier"))
|
109
|
+
GetDimensionKeyDetailsRequest.add_member(:requested_dimensions, Shapes::ShapeRef.new(shape: RequestedDimensionList, location_name: "RequestedDimensions"))
|
110
|
+
GetDimensionKeyDetailsRequest.struct_class = Types::GetDimensionKeyDetailsRequest
|
111
|
+
|
112
|
+
GetDimensionKeyDetailsResponse.add_member(:dimensions, Shapes::ShapeRef.new(shape: DimensionKeyDetailList, location_name: "Dimensions"))
|
113
|
+
GetDimensionKeyDetailsResponse.struct_class = Types::GetDimensionKeyDetailsResponse
|
87
114
|
|
88
115
|
GetResourceMetricsRequest.add_member(:service_type, Shapes::ShapeRef.new(shape: ServiceType, required: true, location_name: "ServiceType"))
|
89
|
-
GetResourceMetricsRequest.add_member(:identifier, Shapes::ShapeRef.new(shape:
|
116
|
+
GetResourceMetricsRequest.add_member(:identifier, Shapes::ShapeRef.new(shape: RequestString, required: true, location_name: "Identifier"))
|
90
117
|
GetResourceMetricsRequest.add_member(:metric_queries, Shapes::ShapeRef.new(shape: MetricQueryList, required: true, location_name: "MetricQueries"))
|
91
118
|
GetResourceMetricsRequest.add_member(:start_time, Shapes::ShapeRef.new(shape: ISOTimestamp, required: true, location_name: "StartTime"))
|
92
119
|
GetResourceMetricsRequest.add_member(:end_time, Shapes::ShapeRef.new(shape: ISOTimestamp, required: true, location_name: "EndTime"))
|
93
120
|
GetResourceMetricsRequest.add_member(:period_in_seconds, Shapes::ShapeRef.new(shape: Integer, location_name: "PeriodInSeconds"))
|
94
121
|
GetResourceMetricsRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxResults, location_name: "MaxResults"))
|
95
|
-
GetResourceMetricsRequest.add_member(:next_token, Shapes::ShapeRef.new(shape:
|
122
|
+
GetResourceMetricsRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "NextToken"))
|
96
123
|
GetResourceMetricsRequest.struct_class = Types::GetResourceMetricsRequest
|
97
124
|
|
98
125
|
GetResourceMetricsResponse.add_member(:aligned_start_time, Shapes::ShapeRef.new(shape: ISOTimestamp, location_name: "AlignedStartTime"))
|
99
126
|
GetResourceMetricsResponse.add_member(:aligned_end_time, Shapes::ShapeRef.new(shape: ISOTimestamp, location_name: "AlignedEndTime"))
|
100
127
|
GetResourceMetricsResponse.add_member(:identifier, Shapes::ShapeRef.new(shape: String, location_name: "Identifier"))
|
101
128
|
GetResourceMetricsResponse.add_member(:metric_list, Shapes::ShapeRef.new(shape: MetricKeyDataPointsList, location_name: "MetricList"))
|
102
|
-
GetResourceMetricsResponse.add_member(:next_token, Shapes::ShapeRef.new(shape:
|
129
|
+
GetResourceMetricsResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "NextToken"))
|
103
130
|
GetResourceMetricsResponse.struct_class = Types::GetResourceMetricsResponse
|
104
131
|
|
105
|
-
InternalServiceError.add_member(:message, Shapes::ShapeRef.new(shape:
|
132
|
+
InternalServiceError.add_member(:message, Shapes::ShapeRef.new(shape: ErrorString, location_name: "Message"))
|
106
133
|
InternalServiceError.struct_class = Types::InternalServiceError
|
107
134
|
|
108
|
-
InvalidArgumentException.add_member(:message, Shapes::ShapeRef.new(shape:
|
135
|
+
InvalidArgumentException.add_member(:message, Shapes::ShapeRef.new(shape: ErrorString, location_name: "Message"))
|
109
136
|
InvalidArgumentException.struct_class = Types::InvalidArgumentException
|
110
137
|
|
111
138
|
MetricKeyDataPoints.add_member(:key, Shapes::ShapeRef.new(shape: ResponseResourceMetricKey, location_name: "Key"))
|
@@ -114,21 +141,25 @@ module Aws::PI
|
|
114
141
|
|
115
142
|
MetricKeyDataPointsList.member = Shapes::ShapeRef.new(shape: MetricKeyDataPoints)
|
116
143
|
|
117
|
-
MetricQuery.add_member(:metric, Shapes::ShapeRef.new(shape:
|
144
|
+
MetricQuery.add_member(:metric, Shapes::ShapeRef.new(shape: RequestString, required: true, location_name: "Metric"))
|
118
145
|
MetricQuery.add_member(:group_by, Shapes::ShapeRef.new(shape: DimensionGroup, location_name: "GroupBy"))
|
119
146
|
MetricQuery.add_member(:filter, Shapes::ShapeRef.new(shape: MetricQueryFilterMap, location_name: "Filter"))
|
120
147
|
MetricQuery.struct_class = Types::MetricQuery
|
121
148
|
|
122
|
-
MetricQueryFilterMap.key = Shapes::ShapeRef.new(shape:
|
123
|
-
MetricQueryFilterMap.value = Shapes::ShapeRef.new(shape:
|
149
|
+
MetricQueryFilterMap.key = Shapes::ShapeRef.new(shape: RequestString)
|
150
|
+
MetricQueryFilterMap.value = Shapes::ShapeRef.new(shape: RequestString)
|
124
151
|
|
125
152
|
MetricQueryList.member = Shapes::ShapeRef.new(shape: MetricQuery)
|
126
153
|
|
127
154
|
MetricValuesList.member = Shapes::ShapeRef.new(shape: Double)
|
128
155
|
|
129
|
-
NotAuthorizedException.add_member(:message, Shapes::ShapeRef.new(shape:
|
156
|
+
NotAuthorizedException.add_member(:message, Shapes::ShapeRef.new(shape: ErrorString, location_name: "Message"))
|
130
157
|
NotAuthorizedException.struct_class = Types::NotAuthorizedException
|
131
158
|
|
159
|
+
RequestStringList.member = Shapes::ShapeRef.new(shape: RequestString)
|
160
|
+
|
161
|
+
RequestedDimensionList.member = Shapes::ShapeRef.new(shape: RequestString)
|
162
|
+
|
132
163
|
ResponsePartitionKey.add_member(:dimensions, Shapes::ShapeRef.new(shape: DimensionMap, required: true, location_name: "Dimensions"))
|
133
164
|
ResponsePartitionKey.struct_class = Types::ResponsePartitionKey
|
134
165
|
|
@@ -138,8 +169,6 @@ module Aws::PI
|
|
138
169
|
ResponseResourceMetricKey.add_member(:dimensions, Shapes::ShapeRef.new(shape: DimensionMap, location_name: "Dimensions"))
|
139
170
|
ResponseResourceMetricKey.struct_class = Types::ResponseResourceMetricKey
|
140
171
|
|
141
|
-
StringList.member = Shapes::ShapeRef.new(shape: String)
|
142
|
-
|
143
172
|
|
144
173
|
# @api private
|
145
174
|
API = Seahorse::Model::Api.new.tap do |api|
|
@@ -171,6 +200,17 @@ module Aws::PI
|
|
171
200
|
o.errors << Shapes::ShapeRef.new(shape: NotAuthorizedException)
|
172
201
|
end)
|
173
202
|
|
203
|
+
api.add_operation(:get_dimension_key_details, Seahorse::Model::Operation.new.tap do |o|
|
204
|
+
o.name = "GetDimensionKeyDetails"
|
205
|
+
o.http_method = "POST"
|
206
|
+
o.http_request_uri = "/"
|
207
|
+
o.input = Shapes::ShapeRef.new(shape: GetDimensionKeyDetailsRequest)
|
208
|
+
o.output = Shapes::ShapeRef.new(shape: GetDimensionKeyDetailsResponse)
|
209
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidArgumentException)
|
210
|
+
o.errors << Shapes::ShapeRef.new(shape: InternalServiceError)
|
211
|
+
o.errors << Shapes::ShapeRef.new(shape: NotAuthorizedException)
|
212
|
+
end)
|
213
|
+
|
174
214
|
api.add_operation(:get_resource_metrics, Seahorse::Model::Operation.new.tap do |o|
|
175
215
|
o.name = "GetResourceMetrics"
|
176
216
|
o.http_method = "POST"
|
data/lib/aws-sdk-pi/errors.rb
CHANGED
@@ -3,7 +3,7 @@
|
|
3
3
|
# WARNING ABOUT GENERATED CODE
|
4
4
|
#
|
5
5
|
# This file is generated. See the contributing guide for more information:
|
6
|
-
# https://github.com/aws/aws-sdk-ruby/blob/
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
7
7
|
#
|
8
8
|
# WARNING ABOUT GENERATED CODE
|
9
9
|
|
data/lib/aws-sdk-pi/resource.rb
CHANGED
@@ -3,7 +3,7 @@
|
|
3
3
|
# WARNING ABOUT GENERATED CODE
|
4
4
|
#
|
5
5
|
# This file is generated. See the contributing guide for more information:
|
6
|
-
# https://github.com/aws/aws-sdk-ruby/blob/
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
7
7
|
#
|
8
8
|
# WARNING ABOUT GENERATED CODE
|
9
9
|
|
data/lib/aws-sdk-pi/types.rb
CHANGED
@@ -3,7 +3,7 @@
|
|
3
3
|
# WARNING ABOUT GENERATED CODE
|
4
4
|
#
|
5
5
|
# This file is generated. See the contributing guide for more information:
|
6
|
-
# https://github.com/aws/aws-sdk-ruby/blob/
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
7
7
|
#
|
8
8
|
# WARNING ABOUT GENERATED CODE
|
9
9
|
|
@@ -35,31 +35,31 @@ module Aws::PI
|
|
35
35
|
#
|
36
36
|
# {
|
37
37
|
# service_type: "RDS", # required, accepts RDS
|
38
|
-
# identifier: "
|
38
|
+
# identifier: "RequestString", # required
|
39
39
|
# start_time: Time.now, # required
|
40
40
|
# end_time: Time.now, # required
|
41
|
-
# metric: "
|
41
|
+
# metric: "RequestString", # required
|
42
42
|
# period_in_seconds: 1,
|
43
43
|
# group_by: { # required
|
44
|
-
# group: "
|
45
|
-
# dimensions: ["
|
44
|
+
# group: "RequestString", # required
|
45
|
+
# dimensions: ["RequestString"],
|
46
46
|
# limit: 1,
|
47
47
|
# },
|
48
48
|
# partition_by: {
|
49
|
-
# group: "
|
50
|
-
# dimensions: ["
|
49
|
+
# group: "RequestString", # required
|
50
|
+
# dimensions: ["RequestString"],
|
51
51
|
# limit: 1,
|
52
52
|
# },
|
53
53
|
# filter: {
|
54
|
-
# "
|
54
|
+
# "RequestString" => "RequestString",
|
55
55
|
# },
|
56
56
|
# max_results: 1,
|
57
|
-
# next_token: "
|
57
|
+
# next_token: "NextToken",
|
58
58
|
# }
|
59
59
|
#
|
60
60
|
# @!attribute [rw] service_type
|
61
61
|
# The AWS service for which Performance Insights will return metrics.
|
62
|
-
# The only valid value for *ServiceType* is
|
62
|
+
# The only valid value for *ServiceType* is `RDS`.
|
63
63
|
# @return [String]
|
64
64
|
#
|
65
65
|
# @!attribute [rw] identifier
|
@@ -67,14 +67,15 @@ module Aws::PI
|
|
67
67
|
# Performance Insights gathers metrics from this data source.
|
68
68
|
#
|
69
69
|
# To use an Amazon RDS instance as a data source, you specify its
|
70
|
-
# `DbiResourceId` value
|
70
|
+
# `DbiResourceId` value. For example, specify
|
71
|
+
# `db-FAIHNTYBKTGAUSUZQYPDS2GW4A`
|
71
72
|
# @return [String]
|
72
73
|
#
|
73
74
|
# @!attribute [rw] start_time
|
74
75
|
# The date and time specifying the beginning of the requested time
|
75
|
-
# series data. You
|
76
|
-
#
|
77
|
-
# or greater than `StartTime`
|
76
|
+
# series data. You must specify a `StartTime` within the past 7 days.
|
77
|
+
# The value specified is *inclusive*, which means that data points
|
78
|
+
# equal to or greater than `StartTime` are returned.
|
78
79
|
#
|
79
80
|
# The value for `StartTime` must be earlier than the value for
|
80
81
|
# `EndTime`.
|
@@ -82,8 +83,8 @@ module Aws::PI
|
|
82
83
|
#
|
83
84
|
# @!attribute [rw] end_time
|
84
85
|
# The date and time specifying the end of the requested time series
|
85
|
-
# data. The value specified is *exclusive
|
86
|
-
# (but not equal to) `EndTime`
|
86
|
+
# data. The value specified is *exclusive*, which means that data
|
87
|
+
# points less than (but not equal to) `EndTime` are returned.
|
87
88
|
#
|
88
89
|
# The value for `EndTime` must be later than the value for
|
89
90
|
# `StartTime`.
|
@@ -99,6 +100,15 @@ module Aws::PI
|
|
99
100
|
#
|
100
101
|
# * `db.sampledload.avg` - the raw number of active sessions for the
|
101
102
|
# database engine.
|
103
|
+
#
|
104
|
+
# If the number of active sessions is less than an internal
|
105
|
+
# Performance Insights threshold, `db.load.avg` and
|
106
|
+
# `db.sampledload.avg` are the same value. If the number of active
|
107
|
+
# sessions is greater than the internal threshold, Performance
|
108
|
+
# Insights samples the active sessions, with `db.load.avg` showing the
|
109
|
+
# scaled values, `db.sampledload.avg` showing the raw values, and
|
110
|
+
# `db.sampledload.avg` less than `db.load.avg`. For most use cases,
|
111
|
+
# you can query `db.load.avg` only.
|
102
112
|
# @return [String]
|
103
113
|
#
|
104
114
|
# @!attribute [rw] period_in_seconds
|
@@ -117,17 +127,17 @@ module Aws::PI
|
|
117
127
|
# * `86400` (twenty-four hours)
|
118
128
|
#
|
119
129
|
# If you don't specify `PeriodInSeconds`, then Performance Insights
|
120
|
-
#
|
121
|
-
#
|
130
|
+
# chooses a value for you, with a goal of returning roughly 100-200
|
131
|
+
# data points in the response.
|
122
132
|
# @return [Integer]
|
123
133
|
#
|
124
134
|
# @!attribute [rw] group_by
|
125
135
|
# A specification for how to aggregate the data points from a query
|
126
136
|
# result. You must specify a valid dimension group. Performance
|
127
|
-
# Insights
|
128
|
-
#
|
129
|
-
#
|
130
|
-
#
|
137
|
+
# Insights returns all dimensions within this group, unless you
|
138
|
+
# provide the names of specific dimensions within this group. You can
|
139
|
+
# also request that Performance Insights return a limited number of
|
140
|
+
# values for a dimension.
|
131
141
|
# @return [Types::DimensionGroup]
|
132
142
|
#
|
133
143
|
# @!attribute [rw] partition_by
|
@@ -222,29 +232,47 @@ module Aws::PI
|
|
222
232
|
# the following dimensions: `db.sql.id`, `db.sql.db_id`,
|
223
233
|
# `db.sql.statement`, and `db.sql.tokenized_id`.
|
224
234
|
#
|
235
|
+
# <note markdown="1"> Each response element returns a maximum of 500 bytes. For larger
|
236
|
+
# elements, such as SQL statements, only the first 500 bytes are
|
237
|
+
# returned.
|
238
|
+
#
|
239
|
+
# </note>
|
240
|
+
#
|
225
241
|
# @note When making an API call, you may pass DimensionGroup
|
226
242
|
# data as a hash:
|
227
243
|
#
|
228
244
|
# {
|
229
|
-
# group: "
|
230
|
-
# dimensions: ["
|
245
|
+
# group: "RequestString", # required
|
246
|
+
# dimensions: ["RequestString"],
|
231
247
|
# limit: 1,
|
232
248
|
# }
|
233
249
|
#
|
234
250
|
# @!attribute [rw] group
|
235
251
|
# The name of the dimension group. Valid values are:
|
236
252
|
#
|
237
|
-
# * `db
|
253
|
+
# * `db` - The name of the database to which the client is connected
|
254
|
+
# (only Aurora PostgreSQL, RDS PostgreSQL, Aurora MySQL, RDS MySQL,
|
255
|
+
# and MariaDB)
|
238
256
|
#
|
239
|
-
# * `db.
|
257
|
+
# * `db.application` - The name of the application that is connected
|
258
|
+
# to the database (only Aurora PostgreSQL and RDS PostgreSQL)
|
240
259
|
#
|
241
|
-
# * `db.
|
260
|
+
# * `db.host` - The host name of the connected client (all engines)
|
242
261
|
#
|
243
|
-
# * `db.
|
262
|
+
# * `db.session_type` - The type of the current session (only Aurora
|
263
|
+
# PostgreSQL and RDS PostgreSQL)
|
244
264
|
#
|
245
|
-
# * `db.
|
265
|
+
# * `db.sql` - The SQL that is currently executing (all engines)
|
246
266
|
#
|
247
|
-
# * `db.
|
267
|
+
# * `db.sql_tokenized` - The SQL digest (all engines)
|
268
|
+
#
|
269
|
+
# * `db.wait_event` - The event for which the database backend is
|
270
|
+
# waiting (all engines)
|
271
|
+
#
|
272
|
+
# * `db.wait_event_type` - The type of event for which the database
|
273
|
+
# backend is waiting (all engines)
|
274
|
+
#
|
275
|
+
# * `db.user` - The user logged in to the database (all engines)
|
248
276
|
# @return [String]
|
249
277
|
#
|
250
278
|
# @!attribute [rw] dimensions
|
@@ -255,33 +283,55 @@ module Aws::PI
|
|
255
283
|
#
|
256
284
|
# Valid values for elements in the `Dimensions` array are:
|
257
285
|
#
|
258
|
-
# * db.
|
286
|
+
# * `db.application.name` - The name of the application that is
|
287
|
+
# connected to the database (only Aurora PostgreSQL and RDS
|
288
|
+
# PostgreSQL)
|
289
|
+
#
|
290
|
+
# * `db.host.id` - The host ID of the connected client (all engines)
|
291
|
+
#
|
292
|
+
# * `db.host.name` - The host name of the connected client (all
|
293
|
+
# engines)
|
259
294
|
#
|
260
|
-
# * db.
|
295
|
+
# * `db.name` - The name of the database to which the client is
|
296
|
+
# connected (only Aurora PostgreSQL, RDS PostgreSQL, Aurora MySQL,
|
297
|
+
# RDS MySQL, and MariaDB)
|
261
298
|
#
|
262
|
-
# * db.
|
299
|
+
# * `db.session_type.name` - The type of the current session (only
|
300
|
+
# Aurora PostgreSQL and RDS PostgreSQL)
|
263
301
|
#
|
264
|
-
# * db.
|
302
|
+
# * `db.sql.id` - The SQL ID generated by Performance Insights (all
|
303
|
+
# engines)
|
265
304
|
#
|
266
|
-
# * db.sql.
|
305
|
+
# * `db.sql.db_id` - The SQL ID generated by the database (all
|
306
|
+
# engines)
|
267
307
|
#
|
268
|
-
# * db.sql.
|
308
|
+
# * `db.sql.statement` - The SQL text that is being executed (all
|
309
|
+
# engines)
|
269
310
|
#
|
270
|
-
# * db.sql.
|
311
|
+
# * `db.sql.tokenized_id`
|
271
312
|
#
|
272
|
-
# * db.
|
313
|
+
# * `db.sql_tokenized.id` - The SQL digest ID generated by Performance
|
314
|
+
# Insights (all engines)
|
273
315
|
#
|
274
|
-
# * db.
|
316
|
+
# * `db.sql_tokenized.db_id` - SQL digest ID generated by the database
|
317
|
+
# (all engines)
|
275
318
|
#
|
276
|
-
# * db.
|
319
|
+
# * `db.sql_tokenized.statement` - The SQL digest text (all engines)
|
277
320
|
#
|
278
|
-
# * db.
|
321
|
+
# * `db.user.id` - The ID of the user logged in to the database (all
|
322
|
+
# engines)
|
279
323
|
#
|
280
|
-
# * db.
|
324
|
+
# * `db.user.name` - The name of the user logged in to the database
|
325
|
+
# (all engines)
|
281
326
|
#
|
282
|
-
# * db.
|
327
|
+
# * `db.wait_event.name` - The event for which the backend is waiting
|
328
|
+
# (all engines)
|
283
329
|
#
|
284
|
-
# * db.
|
330
|
+
# * `db.wait_event.type` - The type of event for which the backend is
|
331
|
+
# waiting (all engines)
|
332
|
+
#
|
333
|
+
# * `db.wait_event_type.name` - The name of the event type for which
|
334
|
+
# the backend is waiting (all engines)
|
285
335
|
# @return [Array<String>]
|
286
336
|
#
|
287
337
|
# @!attribute [rw] limit
|
@@ -325,22 +375,127 @@ module Aws::PI
|
|
325
375
|
include Aws::Structure
|
326
376
|
end
|
327
377
|
|
378
|
+
# An object that describes the details for a specified dimension.
|
379
|
+
#
|
380
|
+
# @!attribute [rw] value
|
381
|
+
# The value of the dimension detail data. For the `db.sql.statement`
|
382
|
+
# dimension, this value is either the full or truncated SQL query,
|
383
|
+
# depending on the return status.
|
384
|
+
# @return [String]
|
385
|
+
#
|
386
|
+
# @!attribute [rw] dimension
|
387
|
+
# The full name of the dimension. The full name includes the group
|
388
|
+
# name and key name. The only valid value is `db.sql.statement`.
|
389
|
+
# @return [String]
|
390
|
+
#
|
391
|
+
# @!attribute [rw] status
|
392
|
+
# The status of the dimension detail data. Possible values include the
|
393
|
+
# following:
|
394
|
+
#
|
395
|
+
# * `AVAILABLE` - The dimension detail data is ready to be retrieved.
|
396
|
+
#
|
397
|
+
# * `PROCESSING` - The dimension detail data isn't ready to be
|
398
|
+
# retrieved because more processing time is required. If the
|
399
|
+
# requested detail data for `db.sql.statement` has the status
|
400
|
+
# `PROCESSING`, Performance Insights returns the truncated query.
|
401
|
+
#
|
402
|
+
# * `UNAVAILABLE` - The dimension detail data could not be collected
|
403
|
+
# successfully.
|
404
|
+
# @return [String]
|
405
|
+
#
|
406
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pi-2018-02-27/DimensionKeyDetail AWS API Documentation
|
407
|
+
#
|
408
|
+
class DimensionKeyDetail < Struct.new(
|
409
|
+
:value,
|
410
|
+
:dimension,
|
411
|
+
:status)
|
412
|
+
SENSITIVE = []
|
413
|
+
include Aws::Structure
|
414
|
+
end
|
415
|
+
|
416
|
+
# @note When making an API call, you may pass GetDimensionKeyDetailsRequest
|
417
|
+
# data as a hash:
|
418
|
+
#
|
419
|
+
# {
|
420
|
+
# service_type: "RDS", # required, accepts RDS
|
421
|
+
# identifier: "IdentifierString", # required
|
422
|
+
# group: "RequestString", # required
|
423
|
+
# group_identifier: "RequestString", # required
|
424
|
+
# requested_dimensions: ["RequestString"],
|
425
|
+
# }
|
426
|
+
#
|
427
|
+
# @!attribute [rw] service_type
|
428
|
+
# The AWS service for which Performance Insights returns data. The
|
429
|
+
# only valid value is `RDS`.
|
430
|
+
# @return [String]
|
431
|
+
#
|
432
|
+
# @!attribute [rw] identifier
|
433
|
+
# The ID for a data source from which to gather dimension data. This
|
434
|
+
# ID must be immutable and unique within an AWS Region. When a DB
|
435
|
+
# instance is the data source, specify its `DbiResourceId` value. For
|
436
|
+
# example, specify `db-ABCDEFGHIJKLMNOPQRSTU1VW2X`.
|
437
|
+
# @return [String]
|
438
|
+
#
|
439
|
+
# @!attribute [rw] group
|
440
|
+
# The name of the dimension group. The only valid value is `db.sql`.
|
441
|
+
# Performance Insights searches the specified group for the dimension
|
442
|
+
# group ID.
|
443
|
+
# @return [String]
|
444
|
+
#
|
445
|
+
# @!attribute [rw] group_identifier
|
446
|
+
# The ID of the dimension group from which to retrieve dimension
|
447
|
+
# details. For dimension group `db.sql`, the group ID is `db.sql.id`.
|
448
|
+
# @return [String]
|
449
|
+
#
|
450
|
+
# @!attribute [rw] requested_dimensions
|
451
|
+
# A list of dimensions to retrieve the detail data for within the
|
452
|
+
# given dimension group. For the dimension group `db.sql`, specify
|
453
|
+
# either the full dimension name `db.sql.statement` or the short
|
454
|
+
# dimension name `statement`. If you don't specify this parameter,
|
455
|
+
# Performance Insights returns all dimension data within the specified
|
456
|
+
# dimension group.
|
457
|
+
# @return [Array<String>]
|
458
|
+
#
|
459
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pi-2018-02-27/GetDimensionKeyDetailsRequest AWS API Documentation
|
460
|
+
#
|
461
|
+
class GetDimensionKeyDetailsRequest < Struct.new(
|
462
|
+
:service_type,
|
463
|
+
:identifier,
|
464
|
+
:group,
|
465
|
+
:group_identifier,
|
466
|
+
:requested_dimensions)
|
467
|
+
SENSITIVE = []
|
468
|
+
include Aws::Structure
|
469
|
+
end
|
470
|
+
|
471
|
+
# @!attribute [rw] dimensions
|
472
|
+
# The details for the requested dimensions.
|
473
|
+
# @return [Array<Types::DimensionKeyDetail>]
|
474
|
+
#
|
475
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pi-2018-02-27/GetDimensionKeyDetailsResponse AWS API Documentation
|
476
|
+
#
|
477
|
+
class GetDimensionKeyDetailsResponse < Struct.new(
|
478
|
+
:dimensions)
|
479
|
+
SENSITIVE = []
|
480
|
+
include Aws::Structure
|
481
|
+
end
|
482
|
+
|
328
483
|
# @note When making an API call, you may pass GetResourceMetricsRequest
|
329
484
|
# data as a hash:
|
330
485
|
#
|
331
486
|
# {
|
332
487
|
# service_type: "RDS", # required, accepts RDS
|
333
|
-
# identifier: "
|
488
|
+
# identifier: "RequestString", # required
|
334
489
|
# metric_queries: [ # required
|
335
490
|
# {
|
336
|
-
# metric: "
|
491
|
+
# metric: "RequestString", # required
|
337
492
|
# group_by: {
|
338
|
-
# group: "
|
339
|
-
# dimensions: ["
|
493
|
+
# group: "RequestString", # required
|
494
|
+
# dimensions: ["RequestString"],
|
340
495
|
# limit: 1,
|
341
496
|
# },
|
342
497
|
# filter: {
|
343
|
-
# "
|
498
|
+
# "RequestString" => "RequestString",
|
344
499
|
# },
|
345
500
|
# },
|
346
501
|
# ],
|
@@ -348,20 +503,20 @@ module Aws::PI
|
|
348
503
|
# end_time: Time.now, # required
|
349
504
|
# period_in_seconds: 1,
|
350
505
|
# max_results: 1,
|
351
|
-
# next_token: "
|
506
|
+
# next_token: "NextToken",
|
352
507
|
# }
|
353
508
|
#
|
354
509
|
# @!attribute [rw] service_type
|
355
|
-
# The AWS service for which Performance Insights
|
356
|
-
#
|
510
|
+
# The AWS service for which Performance Insights returns metrics. The
|
511
|
+
# only valid value for *ServiceType* is `RDS`.
|
357
512
|
# @return [String]
|
358
513
|
#
|
359
514
|
# @!attribute [rw] identifier
|
360
515
|
# An immutable, AWS Region-unique identifier for a data source.
|
361
516
|
# Performance Insights gathers metrics from this data source.
|
362
517
|
#
|
363
|
-
# To use
|
364
|
-
#
|
518
|
+
# To use a DB instance as a data source, specify its `DbiResourceId`
|
519
|
+
# value. For example, specify `db-FAIHNTYBKTGAUSUZQYPDS2GW4A`.
|
365
520
|
# @return [String]
|
366
521
|
#
|
367
522
|
# @!attribute [rw] metric_queries
|
@@ -381,7 +536,7 @@ module Aws::PI
|
|
381
536
|
# @return [Time]
|
382
537
|
#
|
383
538
|
# @!attribute [rw] end_time
|
384
|
-
# The date and time
|
539
|
+
# The date and time specifying the end of the requested time series
|
385
540
|
# data. The value specified is *exclusive* - data points less than
|
386
541
|
# (but not equal to) `EndTime` will be returned.
|
387
542
|
#
|
@@ -455,7 +610,7 @@ module Aws::PI
|
|
455
610
|
# An immutable, AWS Region-unique identifier for a data source.
|
456
611
|
# Performance Insights gathers metrics from this data source.
|
457
612
|
#
|
458
|
-
# To use
|
613
|
+
# To use a DB instance as a data source, you specify its
|
459
614
|
# `DbiResourceId` value - for example: `db-FAIHNTYBKTGAUSUZQYPDS2GW4A`
|
460
615
|
# @return [String]
|
461
616
|
#
|
@@ -508,7 +663,7 @@ module Aws::PI
|
|
508
663
|
include Aws::Structure
|
509
664
|
end
|
510
665
|
|
511
|
-
# A time-ordered series of data points,
|
666
|
+
# A time-ordered series of data points, corresponding to a dimension of
|
512
667
|
# a Performance Insights metric.
|
513
668
|
#
|
514
669
|
# @!attribute [rw] key
|
@@ -539,14 +694,14 @@ module Aws::PI
|
|
539
694
|
# data as a hash:
|
540
695
|
#
|
541
696
|
# {
|
542
|
-
# metric: "
|
697
|
+
# metric: "RequestString", # required
|
543
698
|
# group_by: {
|
544
|
-
# group: "
|
545
|
-
# dimensions: ["
|
699
|
+
# group: "RequestString", # required
|
700
|
+
# dimensions: ["RequestString"],
|
546
701
|
# limit: 1,
|
547
702
|
# },
|
548
703
|
# filter: {
|
549
|
-
# "
|
704
|
+
# "RequestString" => "RequestString",
|
550
705
|
# },
|
551
706
|
# }
|
552
707
|
#
|
@@ -560,6 +715,15 @@ module Aws::PI
|
|
560
715
|
#
|
561
716
|
# * `db.sampledload.avg` - the raw number of active sessions for the
|
562
717
|
# database engine.
|
718
|
+
#
|
719
|
+
# If the number of active sessions is less than an internal
|
720
|
+
# Performance Insights threshold, `db.load.avg` and
|
721
|
+
# `db.sampledload.avg` are the same value. If the number of active
|
722
|
+
# sessions is greater than the internal threshold, Performance
|
723
|
+
# Insights samples the active sessions, with `db.load.avg` showing the
|
724
|
+
# scaled values, `db.sampledload.avg` showing the raw values, and
|
725
|
+
# `db.sampledload.avg` less than `db.load.avg`. For most use cases,
|
726
|
+
# you can query `db.load.avg` only.
|
563
727
|
# @return [String]
|
564
728
|
#
|
565
729
|
# @!attribute [rw] group_by
|
@@ -632,6 +796,15 @@ module Aws::PI
|
|
632
796
|
#
|
633
797
|
# * `db.sampledload.avg` - the raw number of active sessions for the
|
634
798
|
# database engine.
|
799
|
+
#
|
800
|
+
# If the number of active sessions is less than an internal
|
801
|
+
# Performance Insights threshold, `db.load.avg` and
|
802
|
+
# `db.sampledload.avg` are the same value. If the number of active
|
803
|
+
# sessions is greater than the internal threshold, Performance
|
804
|
+
# Insights samples the active sessions, with `db.load.avg` showing the
|
805
|
+
# scaled values, `db.sampledload.avg` showing the raw values, and
|
806
|
+
# `db.sampledload.avg` less than `db.load.avg`. For most use cases,
|
807
|
+
# you can query `db.load.avg` only.
|
635
808
|
# @return [String]
|
636
809
|
#
|
637
810
|
# @!attribute [rw] dimensions
|