@aws-sdk/client-pi 3.295.0 → 3.297.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -7,6 +7,7 @@ import { ListAvailableResourceDimensionsCommandInput, ListAvailableResourceDimen
7
7
  import { ListAvailableResourceMetricsCommandInput, ListAvailableResourceMetricsCommandOutput } from "./commands/ListAvailableResourceMetricsCommand";
8
8
  import { PIClient } from "./PIClient";
9
9
  /**
10
+ * @public
10
11
  * <fullname>Amazon RDS Performance Insights</fullname>
11
12
  * <p>Amazon RDS Performance Insights enables you to monitor and explore different dimensions of database load based on data captured from a running DB instance. The guide
12
13
  * provides detailed information about Performance Insights data types, parameters and errors.</p>
@@ -35,6 +36,7 @@ import { PIClient } from "./PIClient";
35
36
  */
36
37
  export declare class PI extends PIClient {
37
38
  /**
39
+ * @public
38
40
  * <p>For a specific time period, retrieve the top <code>N</code> dimension keys for a metric.
39
41
  * </p>
40
42
  * <note>
@@ -46,6 +48,7 @@ export declare class PI extends PIClient {
46
48
  describeDimensionKeys(args: DescribeDimensionKeysCommandInput, cb: (err: any, data?: DescribeDimensionKeysCommandOutput) => void): void;
47
49
  describeDimensionKeys(args: DescribeDimensionKeysCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDimensionKeysCommandOutput) => void): void;
48
50
  /**
51
+ * @public
49
52
  * <p>Get the attributes of the specified dimension group for a DB instance or data source. For example, if you specify a SQL ID,
50
53
  * <code>GetDimensionKeyDetails</code> retrieves the full text of the dimension <code>db.sql.statement</code> associated with this ID.
51
54
  * This operation is useful because <code>GetResourceMetrics</code> and <code>DescribeDimensionKeys</code> don't support retrieval of large
@@ -55,6 +58,7 @@ export declare class PI extends PIClient {
55
58
  getDimensionKeyDetails(args: GetDimensionKeyDetailsCommandInput, cb: (err: any, data?: GetDimensionKeyDetailsCommandOutput) => void): void;
56
59
  getDimensionKeyDetails(args: GetDimensionKeyDetailsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDimensionKeyDetailsCommandOutput) => void): void;
57
60
  /**
61
+ * @public
58
62
  * <p>Retrieve the metadata for different features. For example, the metadata might indicate
59
63
  * that a feature is turned on or off on a specific DB instance.
60
64
  * </p>
@@ -63,6 +67,7 @@ export declare class PI extends PIClient {
63
67
  getResourceMetadata(args: GetResourceMetadataCommandInput, cb: (err: any, data?: GetResourceMetadataCommandOutput) => void): void;
64
68
  getResourceMetadata(args: GetResourceMetadataCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetResourceMetadataCommandOutput) => void): void;
65
69
  /**
70
+ * @public
66
71
  * <p>Retrieve Performance Insights metrics for a set of data sources over a time period. You can provide
67
72
  * specific dimension groups and dimensions, and provide aggregation and filtering criteria for
68
73
  * each group.</p>
@@ -75,12 +80,14 @@ export declare class PI extends PIClient {
75
80
  getResourceMetrics(args: GetResourceMetricsCommandInput, cb: (err: any, data?: GetResourceMetricsCommandOutput) => void): void;
76
81
  getResourceMetrics(args: GetResourceMetricsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetResourceMetricsCommandOutput) => void): void;
77
82
  /**
83
+ * @public
78
84
  * <p>Retrieve the dimensions that can be queried for each specified metric type on a specified DB instance.</p>
79
85
  */
80
86
  listAvailableResourceDimensions(args: ListAvailableResourceDimensionsCommandInput, options?: __HttpHandlerOptions): Promise<ListAvailableResourceDimensionsCommandOutput>;
81
87
  listAvailableResourceDimensions(args: ListAvailableResourceDimensionsCommandInput, cb: (err: any, data?: ListAvailableResourceDimensionsCommandOutput) => void): void;
82
88
  listAvailableResourceDimensions(args: ListAvailableResourceDimensionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAvailableResourceDimensionsCommandOutput) => void): void;
83
89
  /**
90
+ * @public
84
91
  * <p>Retrieve metrics of the specified types that can be queried for a specified DB instance.
85
92
  * </p>
86
93
  */
@@ -14,15 +14,24 @@ import { GetResourceMetricsCommandInput, GetResourceMetricsCommandOutput } from
14
14
  import { ListAvailableResourceDimensionsCommandInput, ListAvailableResourceDimensionsCommandOutput } from "./commands/ListAvailableResourceDimensionsCommand";
15
15
  import { ListAvailableResourceMetricsCommandInput, ListAvailableResourceMetricsCommandOutput } from "./commands/ListAvailableResourceMetricsCommand";
16
16
  import { ClientInputEndpointParameters, ClientResolvedEndpointParameters, EndpointParameters } from "./endpoint/EndpointParameters";
17
+ /**
18
+ * @public
19
+ */
17
20
  export type ServiceInputTypes = DescribeDimensionKeysCommandInput | GetDimensionKeyDetailsCommandInput | GetResourceMetadataCommandInput | GetResourceMetricsCommandInput | ListAvailableResourceDimensionsCommandInput | ListAvailableResourceMetricsCommandInput;
21
+ /**
22
+ * @public
23
+ */
18
24
  export type ServiceOutputTypes = DescribeDimensionKeysCommandOutput | GetDimensionKeyDetailsCommandOutput | GetResourceMetadataCommandOutput | GetResourceMetricsCommandOutput | ListAvailableResourceDimensionsCommandOutput | ListAvailableResourceMetricsCommandOutput;
25
+ /**
26
+ * @public
27
+ */
19
28
  export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
20
29
  /**
21
30
  * The HTTP handler to use. Fetch in browser and Https in Nodejs.
22
31
  */
23
32
  requestHandler?: __HttpHandler;
24
33
  /**
25
- * A constructor for a class implementing the {@link __Checksum} interface
34
+ * A constructor for a class implementing the {@link @aws-sdk/types#ChecksumConstructor} interface
26
35
  * that computes the SHA-256 HMAC or checksum of a string or binary buffer.
27
36
  * @internal
28
37
  */
@@ -112,23 +121,34 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
112
121
  */
113
122
  logger?: __Logger;
114
123
  /**
115
- * The {@link __DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
124
+ * The {@link @aws-sdk/smithy-client#DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
116
125
  */
117
126
  defaultsMode?: __DefaultsMode | __Provider<__DefaultsMode>;
118
127
  }
128
+ /**
129
+ * @public
130
+ */
119
131
  type PIClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & RegionInputConfig & EndpointInputConfig<EndpointParameters> & RetryInputConfig & HostHeaderInputConfig & AwsAuthInputConfig & UserAgentInputConfig & ClientInputEndpointParameters;
120
132
  /**
121
- * The configuration interface of PIClient class constructor that set the region, credentials and other options.
133
+ * @public
134
+ *
135
+ * The configuration interface of PIClient class constructor that set the region, credentials and other options.
122
136
  */
123
137
  export interface PIClientConfig extends PIClientConfigType {
124
138
  }
139
+ /**
140
+ * @public
141
+ */
125
142
  type PIClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required<ClientDefaults> & RegionResolvedConfig & EndpointResolvedConfig<EndpointParameters> & RetryResolvedConfig & HostHeaderResolvedConfig & AwsAuthResolvedConfig & UserAgentResolvedConfig & ClientResolvedEndpointParameters;
126
143
  /**
127
- * The resolved configuration interface of PIClient class. This is resolved and normalized from the {@link PIClientConfig | constructor configuration interface}.
144
+ * @public
145
+ *
146
+ * The resolved configuration interface of PIClient class. This is resolved and normalized from the {@link PIClientConfig | constructor configuration interface}.
128
147
  */
129
148
  export interface PIClientResolvedConfig extends PIClientResolvedConfigType {
130
149
  }
131
150
  /**
151
+ * @public
132
152
  * <fullname>Amazon RDS Performance Insights</fullname>
133
153
  * <p>Amazon RDS Performance Insights enables you to monitor and explore different dimensions of database load based on data captured from a running DB instance. The guide
134
154
  * provides detailed information about Performance Insights data types, parameters and errors.</p>
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DescribeDimensionKeysRequest, DescribeDimensionKeysResponse } from "../models/models_0";
5
5
  import { PIClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PIClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeDimensionKeysCommand}.
8
10
  */
9
11
  export interface DescribeDimensionKeysCommandInput extends DescribeDimensionKeysRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeDimensionKeysCommand}.
13
17
  */
14
18
  export interface DescribeDimensionKeysCommandOutput extends DescribeDimensionKeysResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>For a specific time period, retrieve the top <code>N</code> dimension keys for a metric.
18
23
  * </p>
19
24
  * <note>
@@ -30,6 +35,8 @@ export interface DescribeDimensionKeysCommandOutput extends DescribeDimensionKey
30
35
  * const response = await client.send(command);
31
36
  * ```
32
37
  *
38
+ * @param DescribeDimensionKeysCommandInput - {@link DescribeDimensionKeysCommandInput}
39
+ * @returns {@link DescribeDimensionKeysCommandOutput}
33
40
  * @see {@link DescribeDimensionKeysCommandInput} for command's `input` shape.
34
41
  * @see {@link DescribeDimensionKeysCommandOutput} for command's `response` shape.
35
42
  * @see {@link PIClientResolvedConfig | config} for PIClient's `config` shape.
@@ -48,11 +55,20 @@ export interface DescribeDimensionKeysCommandOutput extends DescribeDimensionKey
48
55
  export declare class DescribeDimensionKeysCommand extends $Command<DescribeDimensionKeysCommandInput, DescribeDimensionKeysCommandOutput, PIClientResolvedConfig> {
49
56
  readonly input: DescribeDimensionKeysCommandInput;
50
57
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
58
+ /**
59
+ * @public
60
+ */
51
61
  constructor(input: DescribeDimensionKeysCommandInput);
52
62
  /**
53
63
  * @internal
54
64
  */
55
65
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PIClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeDimensionKeysCommandInput, DescribeDimensionKeysCommandOutput>;
66
+ /**
67
+ * @internal
68
+ */
56
69
  private serialize;
70
+ /**
71
+ * @internal
72
+ */
57
73
  private deserialize;
58
74
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { GetDimensionKeyDetailsRequest, GetDimensionKeyDetailsResponse } from "../models/models_0";
5
5
  import { PIClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PIClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetDimensionKeyDetailsCommand}.
8
10
  */
9
11
  export interface GetDimensionKeyDetailsCommandInput extends GetDimensionKeyDetailsRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetDimensionKeyDetailsCommand}.
13
17
  */
14
18
  export interface GetDimensionKeyDetailsCommandOutput extends GetDimensionKeyDetailsResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Get the attributes of the specified dimension group for a DB instance or data source. For example, if you specify a SQL ID,
18
23
  * <code>GetDimensionKeyDetails</code> retrieves the full text of the dimension <code>db.sql.statement</code> associated with this ID.
19
24
  * This operation is useful because <code>GetResourceMetrics</code> and <code>DescribeDimensionKeys</code> don't support retrieval of large
@@ -28,6 +33,8 @@ export interface GetDimensionKeyDetailsCommandOutput extends GetDimensionKeyDeta
28
33
  * const response = await client.send(command);
29
34
  * ```
30
35
  *
36
+ * @param GetDimensionKeyDetailsCommandInput - {@link GetDimensionKeyDetailsCommandInput}
37
+ * @returns {@link GetDimensionKeyDetailsCommandOutput}
31
38
  * @see {@link GetDimensionKeyDetailsCommandInput} for command's `input` shape.
32
39
  * @see {@link GetDimensionKeyDetailsCommandOutput} for command's `response` shape.
33
40
  * @see {@link PIClientResolvedConfig | config} for PIClient's `config` shape.
@@ -46,11 +53,20 @@ export interface GetDimensionKeyDetailsCommandOutput extends GetDimensionKeyDeta
46
53
  export declare class GetDimensionKeyDetailsCommand extends $Command<GetDimensionKeyDetailsCommandInput, GetDimensionKeyDetailsCommandOutput, PIClientResolvedConfig> {
47
54
  readonly input: GetDimensionKeyDetailsCommandInput;
48
55
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
56
+ /**
57
+ * @public
58
+ */
49
59
  constructor(input: GetDimensionKeyDetailsCommandInput);
50
60
  /**
51
61
  * @internal
52
62
  */
53
63
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PIClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetDimensionKeyDetailsCommandInput, GetDimensionKeyDetailsCommandOutput>;
64
+ /**
65
+ * @internal
66
+ */
54
67
  private serialize;
68
+ /**
69
+ * @internal
70
+ */
55
71
  private deserialize;
56
72
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { GetResourceMetadataRequest, GetResourceMetadataResponse } from "../models/models_0";
5
5
  import { PIClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PIClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetResourceMetadataCommand}.
8
10
  */
9
11
  export interface GetResourceMetadataCommandInput extends GetResourceMetadataRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetResourceMetadataCommand}.
13
17
  */
14
18
  export interface GetResourceMetadataCommandOutput extends GetResourceMetadataResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Retrieve the metadata for different features. For example, the metadata might indicate
18
23
  * that a feature is turned on or off on a specific DB instance.
19
24
  * </p>
@@ -27,6 +32,8 @@ export interface GetResourceMetadataCommandOutput extends GetResourceMetadataRes
27
32
  * const response = await client.send(command);
28
33
  * ```
29
34
  *
35
+ * @param GetResourceMetadataCommandInput - {@link GetResourceMetadataCommandInput}
36
+ * @returns {@link GetResourceMetadataCommandOutput}
30
37
  * @see {@link GetResourceMetadataCommandInput} for command's `input` shape.
31
38
  * @see {@link GetResourceMetadataCommandOutput} for command's `response` shape.
32
39
  * @see {@link PIClientResolvedConfig | config} for PIClient's `config` shape.
@@ -45,11 +52,20 @@ export interface GetResourceMetadataCommandOutput extends GetResourceMetadataRes
45
52
  export declare class GetResourceMetadataCommand extends $Command<GetResourceMetadataCommandInput, GetResourceMetadataCommandOutput, PIClientResolvedConfig> {
46
53
  readonly input: GetResourceMetadataCommandInput;
47
54
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
55
+ /**
56
+ * @public
57
+ */
48
58
  constructor(input: GetResourceMetadataCommandInput);
49
59
  /**
50
60
  * @internal
51
61
  */
52
62
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PIClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetResourceMetadataCommandInput, GetResourceMetadataCommandOutput>;
63
+ /**
64
+ * @internal
65
+ */
53
66
  private serialize;
67
+ /**
68
+ * @internal
69
+ */
54
70
  private deserialize;
55
71
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { GetResourceMetricsRequest, GetResourceMetricsResponse } from "../models/models_0";
5
5
  import { PIClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PIClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetResourceMetricsCommand}.
8
10
  */
9
11
  export interface GetResourceMetricsCommandInput extends GetResourceMetricsRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetResourceMetricsCommand}.
13
17
  */
14
18
  export interface GetResourceMetricsCommandOutput extends GetResourceMetricsResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Retrieve Performance Insights metrics for a set of data sources over a time period. You can provide
18
23
  * specific dimension groups and dimensions, and provide aggregation and filtering criteria for
19
24
  * each group.</p>
@@ -31,6 +36,8 @@ export interface GetResourceMetricsCommandOutput extends GetResourceMetricsRespo
31
36
  * const response = await client.send(command);
32
37
  * ```
33
38
  *
39
+ * @param GetResourceMetricsCommandInput - {@link GetResourceMetricsCommandInput}
40
+ * @returns {@link GetResourceMetricsCommandOutput}
34
41
  * @see {@link GetResourceMetricsCommandInput} for command's `input` shape.
35
42
  * @see {@link GetResourceMetricsCommandOutput} for command's `response` shape.
36
43
  * @see {@link PIClientResolvedConfig | config} for PIClient's `config` shape.
@@ -49,11 +56,20 @@ export interface GetResourceMetricsCommandOutput extends GetResourceMetricsRespo
49
56
  export declare class GetResourceMetricsCommand extends $Command<GetResourceMetricsCommandInput, GetResourceMetricsCommandOutput, PIClientResolvedConfig> {
50
57
  readonly input: GetResourceMetricsCommandInput;
51
58
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
59
+ /**
60
+ * @public
61
+ */
52
62
  constructor(input: GetResourceMetricsCommandInput);
53
63
  /**
54
64
  * @internal
55
65
  */
56
66
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PIClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetResourceMetricsCommandInput, GetResourceMetricsCommandOutput>;
67
+ /**
68
+ * @internal
69
+ */
57
70
  private serialize;
71
+ /**
72
+ * @internal
73
+ */
58
74
  private deserialize;
59
75
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ListAvailableResourceDimensionsRequest, ListAvailableResourceDimensionsResponse } from "../models/models_0";
5
5
  import { PIClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PIClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListAvailableResourceDimensionsCommand}.
8
10
  */
9
11
  export interface ListAvailableResourceDimensionsCommandInput extends ListAvailableResourceDimensionsRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListAvailableResourceDimensionsCommand}.
13
17
  */
14
18
  export interface ListAvailableResourceDimensionsCommandOutput extends ListAvailableResourceDimensionsResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Retrieve the dimensions that can be queried for each specified metric type on a specified DB instance.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface ListAvailableResourceDimensionsCommandOutput extends ListAvaila
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param ListAvailableResourceDimensionsCommandInput - {@link ListAvailableResourceDimensionsCommandInput}
34
+ * @returns {@link ListAvailableResourceDimensionsCommandOutput}
28
35
  * @see {@link ListAvailableResourceDimensionsCommandInput} for command's `input` shape.
29
36
  * @see {@link ListAvailableResourceDimensionsCommandOutput} for command's `response` shape.
30
37
  * @see {@link PIClientResolvedConfig | config} for PIClient's `config` shape.
@@ -43,11 +50,20 @@ export interface ListAvailableResourceDimensionsCommandOutput extends ListAvaila
43
50
  export declare class ListAvailableResourceDimensionsCommand extends $Command<ListAvailableResourceDimensionsCommandInput, ListAvailableResourceDimensionsCommandOutput, PIClientResolvedConfig> {
44
51
  readonly input: ListAvailableResourceDimensionsCommandInput;
45
52
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
53
+ /**
54
+ * @public
55
+ */
46
56
  constructor(input: ListAvailableResourceDimensionsCommandInput);
47
57
  /**
48
58
  * @internal
49
59
  */
50
60
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PIClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListAvailableResourceDimensionsCommandInput, ListAvailableResourceDimensionsCommandOutput>;
61
+ /**
62
+ * @internal
63
+ */
51
64
  private serialize;
65
+ /**
66
+ * @internal
67
+ */
52
68
  private deserialize;
53
69
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ListAvailableResourceMetricsRequest, ListAvailableResourceMetricsResponse } from "../models/models_0";
5
5
  import { PIClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PIClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListAvailableResourceMetricsCommand}.
8
10
  */
9
11
  export interface ListAvailableResourceMetricsCommandInput extends ListAvailableResourceMetricsRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListAvailableResourceMetricsCommand}.
13
17
  */
14
18
  export interface ListAvailableResourceMetricsCommandOutput extends ListAvailableResourceMetricsResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Retrieve metrics of the specified types that can be queried for a specified DB instance.
18
23
  * </p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface ListAvailableResourceMetricsCommandOutput extends ListAvailable
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param ListAvailableResourceMetricsCommandInput - {@link ListAvailableResourceMetricsCommandInput}
35
+ * @returns {@link ListAvailableResourceMetricsCommandOutput}
29
36
  * @see {@link ListAvailableResourceMetricsCommandInput} for command's `input` shape.
30
37
  * @see {@link ListAvailableResourceMetricsCommandOutput} for command's `response` shape.
31
38
  * @see {@link PIClientResolvedConfig | config} for PIClient's `config` shape.
@@ -44,11 +51,20 @@ export interface ListAvailableResourceMetricsCommandOutput extends ListAvailable
44
51
  export declare class ListAvailableResourceMetricsCommand extends $Command<ListAvailableResourceMetricsCommandInput, ListAvailableResourceMetricsCommandOutput, PIClientResolvedConfig> {
45
52
  readonly input: ListAvailableResourceMetricsCommandInput;
46
53
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
54
+ /**
55
+ * @public
56
+ */
47
57
  constructor(input: ListAvailableResourceMetricsCommandInput);
48
58
  /**
49
59
  * @internal
50
60
  */
51
61
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PIClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListAvailableResourceMetricsCommandInput, ListAvailableResourceMetricsCommandOutput>;
62
+ /**
63
+ * @internal
64
+ */
52
65
  private serialize;
66
+ /**
67
+ * @internal
68
+ */
53
69
  private deserialize;
54
70
  }
@@ -1,5 +1,7 @@
1
1
  import { ServiceException as __ServiceException, ServiceExceptionOptions as __ServiceExceptionOptions } from "@aws-sdk/smithy-client";
2
2
  /**
3
+ * @public
4
+ *
3
5
  * Base exception class for all service exceptions from PI service.
4
6
  */
5
7
  export declare class PIServiceException extends __ServiceException {
@@ -1,6 +1,7 @@
1
1
  import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-client";
2
2
  import { PIServiceException as __BaseException } from "./PIServiceException";
3
3
  /**
4
+ * @public
4
5
  * <p>A timestamp, and a single numerical value, which together represent a measurement at a particular point in time.</p>
5
6
  */
6
7
  export interface DataPoint {
@@ -14,6 +15,7 @@ export interface DataPoint {
14
15
  Value: number | undefined;
15
16
  }
16
17
  /**
18
+ * @public
17
19
  * <p>A logical grouping of Performance Insights metrics for a related subject area. For example, the
18
20
  * <code>db.sql</code> dimension group consists of the following dimensions:</p>
19
21
  * <ul>
@@ -282,10 +284,16 @@ export interface DimensionGroup {
282
284
  */
283
285
  Limit?: number;
284
286
  }
287
+ /**
288
+ * @public
289
+ */
285
290
  export declare enum ServiceType {
286
291
  DOCDB = "DOCDB",
287
292
  RDS = "RDS"
288
293
  }
294
+ /**
295
+ * @public
296
+ */
289
297
  export interface DescribeDimensionKeysRequest {
290
298
  /**
291
299
  * <p>The Amazon Web Services service for which Performance Insights will return metrics. Valid values are as follows:</p>
@@ -389,7 +397,7 @@ export interface DescribeDimensionKeysRequest {
389
397
  /**
390
398
  * <p>Additional metrics for the top <code>N</code> dimension keys. If the specified dimension group in the <code>GroupBy</code> parameter is
391
399
  * <code>db.sql_tokenized</code>, you can specify per-SQL metrics to get the values for the top <code>N</code> SQL digests. The response
392
- * syntax is as follows: <code>"AdditionalMetrics" : { "<i>string</i>" : "<i>string</i>" }</code>. </p>
400
+ * syntax is as follows: <code>"AdditionalMetrics" : \{ "<i>string</i>" : "<i>string</i>" \}</code>. </p>
393
401
  */
394
402
  AdditionalMetrics?: string[];
395
403
  /**
@@ -423,6 +431,7 @@ export interface DescribeDimensionKeysRequest {
423
431
  NextToken?: string;
424
432
  }
425
433
  /**
434
+ * @public
426
435
  * <p>An object that includes the requested dimension key values and aggregated metric values
427
436
  * within a dimension group.</p>
428
437
  */
@@ -445,6 +454,7 @@ export interface DimensionKeyDescription {
445
454
  Partitions?: number[];
446
455
  }
447
456
  /**
457
+ * @public
448
458
  * <p>If <code>PartitionBy</code> was specified in a <code>DescribeDimensionKeys</code>
449
459
  * request, the dimensions are returned in an array. Each element in the array specifies one
450
460
  * dimension. </p>
@@ -455,6 +465,9 @@ export interface ResponsePartitionKey {
455
465
  */
456
466
  Dimensions: Record<string, string> | undefined;
457
467
  }
468
+ /**
469
+ * @public
470
+ */
458
471
  export interface DescribeDimensionKeysResponse {
459
472
  /**
460
473
  * <p>The start time for the returned dimension keys, after alignment to a granular boundary (as specified by <code>PeriodInSeconds</code>).
@@ -482,6 +495,7 @@ export interface DescribeDimensionKeysResponse {
482
495
  NextToken?: string;
483
496
  }
484
497
  /**
498
+ * @public
485
499
  * <p>The request failed due to an unknown error.</p>
486
500
  */
487
501
  export declare class InternalServiceError extends __BaseException {
@@ -494,6 +508,7 @@ export declare class InternalServiceError extends __BaseException {
494
508
  constructor(opts: __ExceptionOptionType<InternalServiceError, __BaseException>);
495
509
  }
496
510
  /**
511
+ * @public
497
512
  * <p>One of the arguments provided is invalid for this request.</p>
498
513
  */
499
514
  export declare class InvalidArgumentException extends __BaseException {
@@ -506,6 +521,7 @@ export declare class InvalidArgumentException extends __BaseException {
506
521
  constructor(opts: __ExceptionOptionType<InvalidArgumentException, __BaseException>);
507
522
  }
508
523
  /**
524
+ * @public
509
525
  * <p>The user is not authorized to perform this request.</p>
510
526
  */
511
527
  export declare class NotAuthorizedException extends __BaseException {
@@ -517,12 +533,16 @@ export declare class NotAuthorizedException extends __BaseException {
517
533
  */
518
534
  constructor(opts: __ExceptionOptionType<NotAuthorizedException, __BaseException>);
519
535
  }
536
+ /**
537
+ * @public
538
+ */
520
539
  export declare enum DetailStatus {
521
540
  AVAILABLE = "AVAILABLE",
522
541
  PROCESSING = "PROCESSING",
523
542
  UNAVAILABLE = "UNAVAILABLE"
524
543
  }
525
544
  /**
545
+ * @public
526
546
  * <p>The information about a dimension.</p>
527
547
  */
528
548
  export interface DimensionDetail {
@@ -532,6 +552,7 @@ export interface DimensionDetail {
532
552
  Identifier?: string;
533
553
  }
534
554
  /**
555
+ * @public
535
556
  * <p>Information about dimensions within a dimension group.</p>
536
557
  */
537
558
  export interface DimensionGroupDetail {
@@ -545,6 +566,7 @@ export interface DimensionGroupDetail {
545
566
  Dimensions?: DimensionDetail[];
546
567
  }
547
568
  /**
569
+ * @public
548
570
  * <p>An object that describes the details for a specified dimension.</p>
549
571
  */
550
572
  export interface DimensionKeyDetail {
@@ -597,6 +619,9 @@ export interface DimensionKeyDetail {
597
619
  */
598
620
  Status?: DetailStatus | string;
599
621
  }
622
+ /**
623
+ * @public
624
+ */
600
625
  export declare enum FeatureStatus {
601
626
  DISABLED = "DISABLED",
602
627
  DISABLED_PENDING_REBOOT = "DISABLED_PENDING_REBOOT",
@@ -606,6 +631,7 @@ export declare enum FeatureStatus {
606
631
  UNSUPPORTED = "UNSUPPORTED"
607
632
  }
608
633
  /**
634
+ * @public
609
635
  * <p>The metadata for a feature. For example, the metadata might indicate that a feature is
610
636
  * turned on or off on a specific DB instance.</p>
611
637
  */
@@ -641,6 +667,9 @@ export interface FeatureMetadata {
641
667
  */
642
668
  Status?: FeatureStatus | string;
643
669
  }
670
+ /**
671
+ * @public
672
+ */
644
673
  export interface GetDimensionKeyDetailsRequest {
645
674
  /**
646
675
  * <p>The Amazon Web Services service for which Performance Insights returns data. The only valid value is <code>RDS</code>.</p>
@@ -701,12 +730,18 @@ export interface GetDimensionKeyDetailsRequest {
701
730
  */
702
731
  RequestedDimensions?: string[];
703
732
  }
733
+ /**
734
+ * @public
735
+ */
704
736
  export interface GetDimensionKeyDetailsResponse {
705
737
  /**
706
738
  * <p>The details for the requested dimensions.</p>
707
739
  */
708
740
  Dimensions?: DimensionKeyDetail[];
709
741
  }
742
+ /**
743
+ * @public
744
+ */
710
745
  export interface GetResourceMetadataRequest {
711
746
  /**
712
747
  * <p>The Amazon Web Services service for which Performance Insights returns metrics.</p>
@@ -720,6 +755,9 @@ export interface GetResourceMetadataRequest {
720
755
  */
721
756
  Identifier: string | undefined;
722
757
  }
758
+ /**
759
+ * @public
760
+ */
723
761
  export interface GetResourceMetadataResponse {
724
762
  /**
725
763
  * <p>An immutable identifier for a data source that is unique for an Amazon Web Services Region.
@@ -736,6 +774,7 @@ export interface GetResourceMetadataResponse {
736
774
  Features?: Record<string, FeatureMetadata>;
737
775
  }
738
776
  /**
777
+ * @public
739
778
  * <p>A single query to be processed. You must provide the metric to query. If no other
740
779
  * parameters are specified, Performance Insights returns all data points for the specified metric. Optionally, you can
741
780
  * request that the data points be aggregated by dimension group (<code>GroupBy</code>), and return only
@@ -786,10 +825,16 @@ export interface MetricQuery {
786
825
  */
787
826
  Filter?: Record<string, string>;
788
827
  }
828
+ /**
829
+ * @public
830
+ */
789
831
  export declare enum PeriodAlignment {
790
832
  END_TIME = "END_TIME",
791
833
  START_TIME = "START_TIME"
792
834
  }
835
+ /**
836
+ * @public
837
+ */
793
838
  export interface GetResourceMetricsRequest {
794
839
  /**
795
840
  * <p>The Amazon Web Services service for which Performance Insights returns metrics. Valid values are as follows:</p>
@@ -881,6 +926,7 @@ export interface GetResourceMetricsRequest {
881
926
  PeriodAlignment?: PeriodAlignment | string;
882
927
  }
883
928
  /**
929
+ * @public
884
930
  * <p>An object describing a Performance Insights metric and one or more dimensions for that metric.</p>
885
931
  */
886
932
  export interface ResponseResourceMetricKey {
@@ -915,6 +961,7 @@ export interface ResponseResourceMetricKey {
915
961
  Dimensions?: Record<string, string>;
916
962
  }
917
963
  /**
964
+ * @public
918
965
  * <p>A time-ordered series of data points, corresponding to a dimension of a Performance Insights
919
966
  * metric.</p>
920
967
  */
@@ -928,6 +975,9 @@ export interface MetricKeyDataPoints {
928
975
  */
929
976
  DataPoints?: DataPoint[];
930
977
  }
978
+ /**
979
+ * @public
980
+ */
931
981
  export interface GetResourceMetricsResponse {
932
982
  /**
933
983
  * <p>The start time for the returned metrics, after alignment to a granular boundary (as specified by <code>PeriodInSeconds</code>).
@@ -957,6 +1007,9 @@ export interface GetResourceMetricsResponse {
957
1007
  */
958
1008
  NextToken?: string;
959
1009
  }
1010
+ /**
1011
+ * @public
1012
+ */
960
1013
  export interface ListAvailableResourceDimensionsRequest {
961
1014
  /**
962
1015
  * <p>The Amazon Web Services service for which Performance Insights returns metrics.</p>
@@ -986,6 +1039,7 @@ export interface ListAvailableResourceDimensionsRequest {
986
1039
  NextToken?: string;
987
1040
  }
988
1041
  /**
1042
+ * @public
989
1043
  * <p>The available dimension information for a metric type.</p>
990
1044
  */
991
1045
  export interface MetricDimensionGroups {
@@ -998,6 +1052,9 @@ export interface MetricDimensionGroups {
998
1052
  */
999
1053
  Groups?: DimensionGroupDetail[];
1000
1054
  }
1055
+ /**
1056
+ * @public
1057
+ */
1001
1058
  export interface ListAvailableResourceDimensionsResponse {
1002
1059
  /**
1003
1060
  * <p>The dimension information returned for requested metric types.</p>
@@ -1009,6 +1066,9 @@ export interface ListAvailableResourceDimensionsResponse {
1009
1066
  */
1010
1067
  NextToken?: string;
1011
1068
  }
1069
+ /**
1070
+ * @public
1071
+ */
1012
1072
  export interface ListAvailableResourceMetricsRequest {
1013
1073
  /**
1014
1074
  * <p>The Amazon Web Services service for which Performance Insights returns metrics.</p>
@@ -1055,6 +1115,7 @@ export interface ListAvailableResourceMetricsRequest {
1055
1115
  MaxResults?: number;
1056
1116
  }
1057
1117
  /**
1118
+ * @public
1058
1119
  * <p>An object that contains the full name, description, and unit of a metric.
1059
1120
  * </p>
1060
1121
  */
@@ -1072,6 +1133,9 @@ export interface ResponseResourceMetric {
1072
1133
  */
1073
1134
  Unit?: string;
1074
1135
  }
1136
+ /**
1137
+ * @public
1138
+ */
1075
1139
  export interface ListAvailableResourceMetricsResponse {
1076
1140
  /**
1077
1141
  * <p>An array of metrics available to query. Each array element contains the full name,
@@ -1,4 +1,7 @@
1
1
  import { Paginator } from "@aws-sdk/types";
2
2
  import { DescribeDimensionKeysCommandInput, DescribeDimensionKeysCommandOutput } from "../commands/DescribeDimensionKeysCommand";
3
3
  import { PIPaginationConfiguration } from "./Interfaces";
4
+ /**
5
+ * @public
6
+ */
4
7
  export declare function paginateDescribeDimensionKeys(config: PIPaginationConfiguration, input: DescribeDimensionKeysCommandInput, ...additionalArguments: any): Paginator<DescribeDimensionKeysCommandOutput>;
@@ -1,4 +1,7 @@
1
1
  import { Paginator } from "@aws-sdk/types";
2
2
  import { GetResourceMetricsCommandInput, GetResourceMetricsCommandOutput } from "../commands/GetResourceMetricsCommand";
3
3
  import { PIPaginationConfiguration } from "./Interfaces";
4
+ /**
5
+ * @public
6
+ */
4
7
  export declare function paginateGetResourceMetrics(config: PIPaginationConfiguration, input: GetResourceMetricsCommandInput, ...additionalArguments: any): Paginator<GetResourceMetricsCommandOutput>;
@@ -1,5 +1,8 @@
1
1
  import { PaginationConfiguration } from "@aws-sdk/types";
2
2
  import { PIClient } from "../PIClient";
3
+ /**
4
+ * @public
5
+ */
3
6
  export interface PIPaginationConfiguration extends PaginationConfiguration {
4
7
  client: PIClient;
5
8
  }
@@ -1,4 +1,7 @@
1
1
  import { Paginator } from "@aws-sdk/types";
2
2
  import { ListAvailableResourceDimensionsCommandInput, ListAvailableResourceDimensionsCommandOutput } from "../commands/ListAvailableResourceDimensionsCommand";
3
3
  import { PIPaginationConfiguration } from "./Interfaces";
4
+ /**
5
+ * @public
6
+ */
4
7
  export declare function paginateListAvailableResourceDimensions(config: PIPaginationConfiguration, input: ListAvailableResourceDimensionsCommandInput, ...additionalArguments: any): Paginator<ListAvailableResourceDimensionsCommandOutput>;
@@ -1,4 +1,7 @@
1
1
  import { Paginator } from "@aws-sdk/types";
2
2
  import { ListAvailableResourceMetricsCommandInput, ListAvailableResourceMetricsCommandOutput } from "../commands/ListAvailableResourceMetricsCommand";
3
3
  import { PIPaginationConfiguration } from "./Interfaces";
4
+ /**
5
+ * @public
6
+ */
4
7
  export declare function paginateListAvailableResourceMetrics(config: PIPaginationConfiguration, input: ListAvailableResourceMetricsCommandInput, ...additionalArguments: any): Paginator<ListAvailableResourceMetricsCommandOutput>;
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-pi",
3
3
  "description": "AWS SDK for JavaScript Pi Client for Node.js, Browser and React Native",
4
- "version": "3.295.0",
4
+ "version": "3.297.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -20,37 +20,37 @@
20
20
  "dependencies": {
21
21
  "@aws-crypto/sha256-browser": "3.0.0",
22
22
  "@aws-crypto/sha256-js": "3.0.0",
23
- "@aws-sdk/client-sts": "3.295.0",
24
- "@aws-sdk/config-resolver": "3.295.0",
25
- "@aws-sdk/credential-provider-node": "3.295.0",
26
- "@aws-sdk/fetch-http-handler": "3.295.0",
27
- "@aws-sdk/hash-node": "3.295.0",
28
- "@aws-sdk/invalid-dependency": "3.295.0",
29
- "@aws-sdk/middleware-content-length": "3.295.0",
30
- "@aws-sdk/middleware-endpoint": "3.295.0",
31
- "@aws-sdk/middleware-host-header": "3.295.0",
32
- "@aws-sdk/middleware-logger": "3.295.0",
33
- "@aws-sdk/middleware-recursion-detection": "3.295.0",
34
- "@aws-sdk/middleware-retry": "3.295.0",
35
- "@aws-sdk/middleware-serde": "3.295.0",
36
- "@aws-sdk/middleware-signing": "3.295.0",
37
- "@aws-sdk/middleware-stack": "3.295.0",
38
- "@aws-sdk/middleware-user-agent": "3.295.0",
39
- "@aws-sdk/node-config-provider": "3.295.0",
40
- "@aws-sdk/node-http-handler": "3.295.0",
41
- "@aws-sdk/protocol-http": "3.295.0",
42
- "@aws-sdk/smithy-client": "3.295.0",
43
- "@aws-sdk/types": "3.295.0",
44
- "@aws-sdk/url-parser": "3.295.0",
23
+ "@aws-sdk/client-sts": "3.297.0",
24
+ "@aws-sdk/config-resolver": "3.296.0",
25
+ "@aws-sdk/credential-provider-node": "3.297.0",
26
+ "@aws-sdk/fetch-http-handler": "3.296.0",
27
+ "@aws-sdk/hash-node": "3.296.0",
28
+ "@aws-sdk/invalid-dependency": "3.296.0",
29
+ "@aws-sdk/middleware-content-length": "3.296.0",
30
+ "@aws-sdk/middleware-endpoint": "3.296.0",
31
+ "@aws-sdk/middleware-host-header": "3.296.0",
32
+ "@aws-sdk/middleware-logger": "3.296.0",
33
+ "@aws-sdk/middleware-recursion-detection": "3.296.0",
34
+ "@aws-sdk/middleware-retry": "3.296.0",
35
+ "@aws-sdk/middleware-serde": "3.296.0",
36
+ "@aws-sdk/middleware-signing": "3.296.0",
37
+ "@aws-sdk/middleware-stack": "3.296.0",
38
+ "@aws-sdk/middleware-user-agent": "3.296.0",
39
+ "@aws-sdk/node-config-provider": "3.296.0",
40
+ "@aws-sdk/node-http-handler": "3.296.0",
41
+ "@aws-sdk/protocol-http": "3.296.0",
42
+ "@aws-sdk/smithy-client": "3.296.0",
43
+ "@aws-sdk/types": "3.296.0",
44
+ "@aws-sdk/url-parser": "3.296.0",
45
45
  "@aws-sdk/util-base64": "3.295.0",
46
46
  "@aws-sdk/util-body-length-browser": "3.295.0",
47
47
  "@aws-sdk/util-body-length-node": "3.295.0",
48
- "@aws-sdk/util-defaults-mode-browser": "3.295.0",
49
- "@aws-sdk/util-defaults-mode-node": "3.295.0",
50
- "@aws-sdk/util-endpoints": "3.295.0",
51
- "@aws-sdk/util-retry": "3.295.0",
52
- "@aws-sdk/util-user-agent-browser": "3.295.0",
53
- "@aws-sdk/util-user-agent-node": "3.295.0",
48
+ "@aws-sdk/util-defaults-mode-browser": "3.296.0",
49
+ "@aws-sdk/util-defaults-mode-node": "3.296.0",
50
+ "@aws-sdk/util-endpoints": "3.296.0",
51
+ "@aws-sdk/util-retry": "3.296.0",
52
+ "@aws-sdk/util-user-agent-browser": "3.296.0",
53
+ "@aws-sdk/util-user-agent-node": "3.296.0",
54
54
  "@aws-sdk/util-utf8": "3.295.0",
55
55
  "tslib": "^2.5.0"
56
56
  },