-
Notifications
You must be signed in to change notification settings - Fork 597
/
api_op_DescribeDimensionKeys.go
360 lines (313 loc) · 11.8 KB
/
api_op_DescribeDimensionKeys.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
// Code generated by smithy-go-codegen DO NOT EDIT.
package pi
import (
"context"
"fmt"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/service/pi/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
"time"
)
// For a specific time period, retrieve the top N dimension keys for a metric.
//
// Each response element returns a maximum of 500 bytes. For larger elements, such
// as SQL statements, only the first 500 bytes are returned.
func (c *Client) DescribeDimensionKeys(ctx context.Context, params *DescribeDimensionKeysInput, optFns ...func(*Options)) (*DescribeDimensionKeysOutput, error) {
if params == nil {
params = &DescribeDimensionKeysInput{}
}
result, metadata, err := c.invokeOperation(ctx, "DescribeDimensionKeys", params, optFns, c.addOperationDescribeDimensionKeysMiddlewares)
if err != nil {
return nil, err
}
out := result.(*DescribeDimensionKeysOutput)
out.ResultMetadata = metadata
return out, nil
}
type DescribeDimensionKeysInput struct {
// The date and time specifying the end of the requested time series data. The
// value specified is exclusive, which means that data points less than (but not
// equal to) EndTime are returned.
//
// The value for EndTime must be later than the value for StartTime .
//
// This member is required.
EndTime *time.Time
// A specification for how to aggregate the data points from a query result. You
// must specify a valid dimension group. Performance Insights returns all
// dimensions within this group, unless you provide the names of specific
// dimensions within this group. You can also request that Performance Insights
// return a limited number of values for a dimension.
//
// This member is required.
GroupBy *types.DimensionGroup
// An immutable, Amazon Web Services Region-unique identifier for a data source.
// Performance Insights gathers metrics from this data source.
//
// To use an Amazon RDS instance as a data source, you specify its DbiResourceId
// value. For example, specify db-FAIHNTYBKTGAUSUZQYPDS2GW4A .
//
// This member is required.
Identifier *string
// The name of a Performance Insights metric to be measured.
//
// Valid values for Metric are:
//
// - db.load.avg - A scaled representation of the number of active sessions for
// the database engine.
//
// - db.sampledload.avg - The raw number of active sessions for the database
// engine.
//
// If the number of active sessions is less than an internal Performance Insights
// threshold, db.load.avg and db.sampledload.avg are the same value. If the number
// of active sessions is greater than the internal threshold, Performance Insights
// samples the active sessions, with db.load.avg showing the scaled values,
// db.sampledload.avg showing the raw values, and db.sampledload.avg less than
// db.load.avg . For most use cases, you can query db.load.avg only.
//
// This member is required.
Metric *string
// The Amazon Web Services service for which Performance Insights will return
// metrics. Valid values are as follows:
//
// - RDS
//
// - DOCDB
//
// This member is required.
ServiceType types.ServiceType
// The date and time specifying the beginning of the requested time series data.
// You must specify a StartTime within the past 7 days. The value specified is
// inclusive, which means that data points equal to or greater than StartTime are
// returned.
//
// The value for StartTime must be earlier than the value for EndTime .
//
// This member is required.
StartTime *time.Time
// Additional metrics for the top N dimension keys. If the specified dimension
// group in the GroupBy parameter is db.sql_tokenized , you can specify per-SQL
// metrics to get the values for the top N SQL digests. The response syntax is as
// follows: "AdditionalMetrics" : { "string" : "string" } .
AdditionalMetrics []string
// One or more filters to apply in the request. Restrictions:
//
// - Any number of filters by the same dimension, as specified in the GroupBy or
// Partition parameters.
//
// - A single filter for any other dimension in this dimension group.
Filter map[string]string
// The maximum number of items to return in the response. If more items exist than
// the specified MaxRecords value, a pagination token is included in the response
// so that the remaining results can be retrieved.
MaxResults *int32
// An optional pagination token provided by a previous request. If this parameter
// is specified, the response includes only records beyond the token, up to the
// value specified by MaxRecords .
NextToken *string
// For each dimension specified in GroupBy , specify a secondary dimension to
// further subdivide the partition keys in the response.
PartitionBy *types.DimensionGroup
// The granularity, in seconds, of the data points returned from Performance
// Insights. A period can be as short as one second, or as long as one day (86400
// seconds). Valid values are:
//
// - 1 (one second)
//
// - 60 (one minute)
//
// - 300 (five minutes)
//
// - 3600 (one hour)
//
// - 86400 (twenty-four hours)
//
// If you don't specify PeriodInSeconds , then Performance Insights chooses a value
// for you, with a goal of returning roughly 100-200 data points in the response.
PeriodInSeconds *int32
noSmithyDocumentSerde
}
type DescribeDimensionKeysOutput struct {
// The end time for the returned dimension keys, after alignment to a granular
// boundary (as specified by PeriodInSeconds ). AlignedEndTime will be greater
// than or equal to the value of the user-specified Endtime .
AlignedEndTime *time.Time
// The start time for the returned dimension keys, after alignment to a granular
// boundary (as specified by PeriodInSeconds ). AlignedStartTime will be less than
// or equal to the value of the user-specified StartTime .
AlignedStartTime *time.Time
// The dimension keys that were requested.
Keys []types.DimensionKeyDescription
// A pagination token that indicates the response didn’t return all available
// records because MaxRecords was specified in the previous request. To get the
// remaining records, specify NextToken in a separate request with this value.
NextToken *string
// If PartitionBy was present in the request, PartitionKeys contains the breakdown
// of dimension keys by the specified partitions.
PartitionKeys []types.ResponsePartitionKey
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationDescribeDimensionKeysMiddlewares(stack *middleware.Stack, options Options) (err error) {
if err := stack.Serialize.Add(&setOperationInputMiddleware{}, middleware.After); err != nil {
return err
}
err = stack.Serialize.Add(&awsAwsjson11_serializeOpDescribeDimensionKeys{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsAwsjson11_deserializeOpDescribeDimensionKeys{}, middleware.After)
if err != nil {
return err
}
if err := addProtocolFinalizerMiddlewares(stack, options, "DescribeDimensionKeys"); err != nil {
return fmt.Errorf("add protocol finalizers: %v", err)
}
if err = addlegacyEndpointContextSetter(stack, options); err != nil {
return err
}
if err = addSetLoggerMiddleware(stack, options); err != nil {
return err
}
if err = addClientRequestID(stack); err != nil {
return err
}
if err = addComputeContentLength(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = addComputePayloadSHA256(stack); err != nil {
return err
}
if err = addRetry(stack, options); err != nil {
return err
}
if err = addRawResponseToMetadata(stack); err != nil {
return err
}
if err = addRecordResponseTiming(stack); err != nil {
return err
}
if err = addClientUserAgent(stack, options); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = addSetLegacyContextSigningOptionsMiddleware(stack); err != nil {
return err
}
if err = addOpDescribeDimensionKeysValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opDescribeDimensionKeys(options.Region), middleware.Before); err != nil {
return err
}
if err = addRecursionDetection(stack); err != nil {
return err
}
if err = addRequestIDRetrieverMiddleware(stack); err != nil {
return err
}
if err = addResponseErrorMiddleware(stack); err != nil {
return err
}
if err = addRequestResponseLogging(stack, options); err != nil {
return err
}
if err = addDisableHTTPSMiddleware(stack, options); err != nil {
return err
}
return nil
}
// DescribeDimensionKeysAPIClient is a client that implements the
// DescribeDimensionKeys operation.
type DescribeDimensionKeysAPIClient interface {
DescribeDimensionKeys(context.Context, *DescribeDimensionKeysInput, ...func(*Options)) (*DescribeDimensionKeysOutput, error)
}
var _ DescribeDimensionKeysAPIClient = (*Client)(nil)
// DescribeDimensionKeysPaginatorOptions is the paginator options for
// DescribeDimensionKeys
type DescribeDimensionKeysPaginatorOptions struct {
// The maximum number of items to return in the response. If more items exist than
// the specified MaxRecords value, a pagination token is included in the response
// so that the remaining results can be retrieved.
Limit int32
// Set to true if pagination should stop if the service returns a pagination token
// that matches the most recent token provided to the service.
StopOnDuplicateToken bool
}
// DescribeDimensionKeysPaginator is a paginator for DescribeDimensionKeys
type DescribeDimensionKeysPaginator struct {
options DescribeDimensionKeysPaginatorOptions
client DescribeDimensionKeysAPIClient
params *DescribeDimensionKeysInput
nextToken *string
firstPage bool
}
// NewDescribeDimensionKeysPaginator returns a new DescribeDimensionKeysPaginator
func NewDescribeDimensionKeysPaginator(client DescribeDimensionKeysAPIClient, params *DescribeDimensionKeysInput, optFns ...func(*DescribeDimensionKeysPaginatorOptions)) *DescribeDimensionKeysPaginator {
if params == nil {
params = &DescribeDimensionKeysInput{}
}
options := DescribeDimensionKeysPaginatorOptions{}
if params.MaxResults != nil {
options.Limit = *params.MaxResults
}
for _, fn := range optFns {
fn(&options)
}
return &DescribeDimensionKeysPaginator{
options: options,
client: client,
params: params,
firstPage: true,
nextToken: params.NextToken,
}
}
// HasMorePages returns a boolean indicating whether more pages are available
func (p *DescribeDimensionKeysPaginator) HasMorePages() bool {
return p.firstPage || (p.nextToken != nil && len(*p.nextToken) != 0)
}
// NextPage retrieves the next DescribeDimensionKeys page.
func (p *DescribeDimensionKeysPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeDimensionKeysOutput, error) {
if !p.HasMorePages() {
return nil, fmt.Errorf("no more pages available")
}
params := *p.params
params.NextToken = p.nextToken
var limit *int32
if p.options.Limit > 0 {
limit = &p.options.Limit
}
params.MaxResults = limit
result, err := p.client.DescribeDimensionKeys(ctx, ¶ms, optFns...)
if err != nil {
return nil, err
}
p.firstPage = false
prevToken := p.nextToken
p.nextToken = result.NextToken
if p.options.StopOnDuplicateToken &&
prevToken != nil &&
p.nextToken != nil &&
*prevToken == *p.nextToken {
p.nextToken = nil
}
return result, nil
}
func newServiceMetadataMiddleware_opDescribeDimensionKeys(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
OperationName: "DescribeDimensionKeys",
}
}