@aws-sdk/client-pi 3.56.0 → 3.67.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.
Files changed (8) hide show
  1. package/CHANGELOG.md +27 -0
  2. package/README.md +20 -21
  3. package/dist-types/PI.d.ts +23 -26
  4. package/dist-types/PIClient.d.ts +18 -20
  5. package/dist-types/commands/GetDimensionKeyDetailsCommand.d.ts +4 -5
  6. package/dist-types/commands/GetResourceMetricsCommand.d.ts +1 -1
  7. package/dist-types/models/models_0.d.ts +425 -261
  8. package/package.json +18 -18
package/CHANGELOG.md CHANGED
@@ -3,6 +3,33 @@
3
3
  All notable changes to this project will be documented in this file.
4
4
  See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
5
5
 
6
+ # [3.67.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.66.0...v3.67.0) (2022-04-08)
7
+
8
+ **Note:** Version bump only for package @aws-sdk/client-pi
9
+
10
+
11
+
12
+
13
+
14
+ # [3.66.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.65.0...v3.66.0) (2022-04-07)
15
+
16
+
17
+ ### Features
18
+
19
+ * **clients:** Adds support for DocumentDB to the Performance Insights API. ([#3520](https://github.com/aws/aws-sdk-js-v3/issues/3520)) ([4aaf58a](https://github.com/aws/aws-sdk-js-v3/commit/4aaf58aa983f1c30430e5ce57cb47a36837c590b))
20
+
21
+
22
+
23
+
24
+
25
+ # [3.58.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.57.0...v3.58.0) (2022-03-28)
26
+
27
+ **Note:** Version bump only for package @aws-sdk/client-pi
28
+
29
+
30
+
31
+
32
+
6
33
  # [3.56.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.55.0...v3.56.0) (2022-03-24)
7
34
 
8
35
  **Note:** Version bump only for package @aws-sdk/client-pi
package/README.md CHANGED
@@ -9,29 +9,28 @@ AWS SDK for JavaScript PI Client for Node.js, Browser and React Native.
9
9
 
10
10
  <fullname>Amazon RDS Performance Insights</fullname>
11
11
 
12
- <p>Amazon RDS Performance Insights enables you to monitor and explore different dimensions of database load based on
13
- data captured from a running DB instance. The guide provides detailed information about Performance Insights
14
- data types, parameters and errors.
15
- </p>
16
-
17
- <p>When Performance Insights is enabled, the Amazon RDS Performance Insights API provides visibility into the performance of your DB instance.
18
- Amazon CloudWatch provides the authoritative source for Amazon Web Services service-vended monitoring metrics.
19
- Performance Insights offers a domain-specific view of DB load.
20
- </p>
21
- <p>DB load is measured as average active sessions. Performance Insights provides the data to API consumers as a two-dimensional
22
- time-series dataset. The time dimension provides DB load data for each time point in the
23
- queried time range. Each time point decomposes overall load in relation to the requested dimensions,
24
- measured at that time point. Examples include SQL, Wait event, User, and Host.
25
- </p>
26
-
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
13
+ provides detailed information about Performance Insights data types, parameters and errors.</p>
14
+ <p>When Performance Insights is enabled, the Amazon RDS Performance Insights API provides visibility into the performance of your DB instance. Amazon CloudWatch provides the
15
+ authoritative source for Amazon Web Services service-vended monitoring metrics. Performance Insights offers a domain-specific view of DB load.</p>
16
+ <p>DB load is measured as average active sessions. Performance Insights provides the data to API consumers as a two-dimensional time-series dataset. The time dimension
17
+ provides DB load data for each time point in the queried time range. Each time point decomposes overall load in relation to the requested
18
+ dimensions, measured at that time point. Examples include SQL, Wait event, User, and Host.</p>
27
19
  <ul>
28
20
  <li>
29
- <p>To learn more about Performance Insights and Amazon Aurora DB instances, go to the <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_PerfInsights.html"> Amazon Aurora User Guide</a>.
30
- </p>
21
+ <p>To learn more about Performance Insights and Amazon Aurora DB instances, go to the <i>
22
+ <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_PerfInsights.html"> Amazon Aurora User Guide</a>
23
+ </i>. </p>
24
+ </li>
25
+ <li>
26
+ <p>To learn more about Performance Insights and Amazon RDS DB instances, go to the <i>
27
+ <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html"> Amazon RDS User Guide</a>
28
+ </i>. </p>
31
29
  </li>
32
30
  <li>
33
- <p>To learn more about Performance Insights and Amazon RDS DB instances, go to the <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html"> Amazon RDS User Guide</a>.
34
- </p>
31
+ <p>To learn more about Performance Insights and Amazon DocumentDB clusters, go to the <i>
32
+ <a href="https://docs.aws.amazon.com/documentdb/latest/developerguide/performance-insights.html"> Amazon DocumentDB Developer Guide</a>
33
+ </i>.</p>
35
34
  </li>
36
35
  </ul>
37
36
 
@@ -141,7 +140,7 @@ but they are supported by the send operation.
141
140
  ```js
142
141
  // callbacks.
143
142
  client.send(command, (err, data) => {
144
- // proccess err and data.
143
+ // process err and data.
145
144
  });
146
145
  ```
147
146
 
@@ -175,7 +174,7 @@ client
175
174
 
176
175
  // callbacks.
177
176
  client.describeDimensionKeys(params, (err, data) => {
178
- // proccess err and data.
177
+ // process err and data.
179
178
  });
180
179
  ```
181
180
 
package/dist-types/PI.d.ts CHANGED
@@ -8,30 +8,28 @@ import { ListAvailableResourceMetricsCommandInput, ListAvailableResourceMetricsC
8
8
  import { PIClient } from "./PIClient";
9
9
  /**
10
10
  * <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
13
- * data captured from a running DB instance. The guide provides detailed information about Performance Insights
14
- * data types, parameters and errors.
15
- * </p>
16
- *
17
- * <p>When Performance Insights is enabled, the Amazon RDS Performance Insights API provides visibility into the performance of your DB instance.
18
- * Amazon CloudWatch provides the authoritative source for Amazon Web Services service-vended monitoring metrics.
19
- * Performance Insights offers a domain-specific view of DB load.
20
- * </p>
21
- * <p>DB load is measured as average active sessions. Performance Insights provides the data to API consumers as a two-dimensional
22
- * time-series dataset. The time dimension provides DB load data for each time point in the
23
- * queried time range. Each time point decomposes overall load in relation to the requested dimensions,
24
- * measured at that time point. Examples include SQL, Wait event, User, and Host.
25
- * </p>
26
- *
11
+ * <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
+ * provides detailed information about Performance Insights data types, parameters and errors.</p>
13
+ * <p>When Performance Insights is enabled, the Amazon RDS Performance Insights API provides visibility into the performance of your DB instance. Amazon CloudWatch provides the
14
+ * authoritative source for Amazon Web Services service-vended monitoring metrics. Performance Insights offers a domain-specific view of DB load.</p>
15
+ * <p>DB load is measured as average active sessions. Performance Insights provides the data to API consumers as a two-dimensional time-series dataset. The time dimension
16
+ * provides DB load data for each time point in the queried time range. Each time point decomposes overall load in relation to the requested
17
+ * dimensions, measured at that time point. Examples include SQL, Wait event, User, and Host.</p>
27
18
  * <ul>
28
19
  * <li>
29
- * <p>To learn more about Performance Insights and Amazon Aurora DB instances, go to the <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_PerfInsights.html"> Amazon Aurora User Guide</a>.
30
- * </p>
20
+ * <p>To learn more about Performance Insights and Amazon Aurora DB instances, go to the <i>
21
+ * <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_PerfInsights.html"> Amazon Aurora User Guide</a>
22
+ * </i>. </p>
31
23
  * </li>
32
24
  * <li>
33
- * <p>To learn more about Performance Insights and Amazon RDS DB instances, go to the <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html"> Amazon RDS User Guide</a>.
34
- * </p>
25
+ * <p>To learn more about Performance Insights and Amazon RDS DB instances, go to the <i>
26
+ * <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html"> Amazon RDS User Guide</a>
27
+ * </i>. </p>
28
+ * </li>
29
+ * <li>
30
+ * <p>To learn more about Performance Insights and Amazon DocumentDB clusters, go to the <i>
31
+ * <a href="https://docs.aws.amazon.com/documentdb/latest/developerguide/performance-insights.html"> Amazon DocumentDB Developer Guide</a>
32
+ * </i>.</p>
35
33
  * </li>
36
34
  * </ul>
37
35
  */
@@ -48,11 +46,10 @@ export declare class PI extends PIClient {
48
46
  describeDimensionKeys(args: DescribeDimensionKeysCommandInput, cb: (err: any, data?: DescribeDimensionKeysCommandOutput) => void): void;
49
47
  describeDimensionKeys(args: DescribeDimensionKeysCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDimensionKeysCommandOutput) => void): void;
50
48
  /**
51
- * <p>Get the attributes of the specified dimension group for a DB instance or data source.
52
- * For example, if you specify a SQL ID, <code>GetDimensionKeyDetails</code> retrieves
53
- * the full text of the dimension <code>db.sql.statement</code>cassociated with this ID.
54
- * This operation is useful because <code>GetResourceMetrics</code> and <code>DescribeDimensionKeys</code>
55
- * don't support retrieval of large SQL statement text.</p>
49
+ * <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
+ * <code>GetDimensionKeyDetails</code> retrieves the full text of the dimension <code>db.sql.statement</code> associated with this ID.
51
+ * This operation is useful because <code>GetResourceMetrics</code> and <code>DescribeDimensionKeys</code> don't support retrieval of large
52
+ * SQL statement text.</p>
56
53
  */
57
54
  getDimensionKeyDetails(args: GetDimensionKeyDetailsCommandInput, options?: __HttpHandlerOptions): Promise<GetDimensionKeyDetailsCommandOutput>;
58
55
  getDimensionKeyDetails(args: GetDimensionKeyDetailsCommandInput, cb: (err: any, data?: GetDimensionKeyDetailsCommandOutput) => void): void;
@@ -66,7 +63,7 @@ export declare class PI extends PIClient {
66
63
  getResourceMetadata(args: GetResourceMetadataCommandInput, cb: (err: any, data?: GetResourceMetadataCommandOutput) => void): void;
67
64
  getResourceMetadata(args: GetResourceMetadataCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetResourceMetadataCommandOutput) => void): void;
68
65
  /**
69
- * <p>Retrieve Performance Insights metrics for a set of data sources, over a time period. You can provide
66
+ * <p>Retrieve Performance Insights metrics for a set of data sources over a time period. You can provide
70
67
  * specific dimension groups and dimensions, and provide aggregation and filtering criteria for
71
68
  * each group.</p>
72
69
  * <note>
package/dist-types/PIClient.d.ts CHANGED
@@ -133,30 +133,28 @@ export interface PIClientResolvedConfig extends PIClientResolvedConfigType {
133
133
  }
134
134
  /**
135
135
  * <fullname>Amazon RDS Performance Insights</fullname>
136
- *
137
- * <p>Amazon RDS Performance Insights enables you to monitor and explore different dimensions of database load based on
138
- * data captured from a running DB instance. The guide provides detailed information about Performance Insights
139
- * data types, parameters and errors.
140
- * </p>
141
- *
142
- * <p>When Performance Insights is enabled, the Amazon RDS Performance Insights API provides visibility into the performance of your DB instance.
143
- * Amazon CloudWatch provides the authoritative source for Amazon Web Services service-vended monitoring metrics.
144
- * Performance Insights offers a domain-specific view of DB load.
145
- * </p>
146
- * <p>DB load is measured as average active sessions. Performance Insights provides the data to API consumers as a two-dimensional
147
- * time-series dataset. The time dimension provides DB load data for each time point in the
148
- * queried time range. Each time point decomposes overall load in relation to the requested dimensions,
149
- * measured at that time point. Examples include SQL, Wait event, User, and Host.
150
- * </p>
151
- *
136
+ * <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
137
+ * provides detailed information about Performance Insights data types, parameters and errors.</p>
138
+ * <p>When Performance Insights is enabled, the Amazon RDS Performance Insights API provides visibility into the performance of your DB instance. Amazon CloudWatch provides the
139
+ * authoritative source for Amazon Web Services service-vended monitoring metrics. Performance Insights offers a domain-specific view of DB load.</p>
140
+ * <p>DB load is measured as average active sessions. Performance Insights provides the data to API consumers as a two-dimensional time-series dataset. The time dimension
141
+ * provides DB load data for each time point in the queried time range. Each time point decomposes overall load in relation to the requested
142
+ * dimensions, measured at that time point. Examples include SQL, Wait event, User, and Host.</p>
152
143
  * <ul>
153
144
  * <li>
154
- * <p>To learn more about Performance Insights and Amazon Aurora DB instances, go to the <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_PerfInsights.html"> Amazon Aurora User Guide</a>.
155
- * </p>
145
+ * <p>To learn more about Performance Insights and Amazon Aurora DB instances, go to the <i>
146
+ * <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_PerfInsights.html"> Amazon Aurora User Guide</a>
147
+ * </i>. </p>
156
148
  * </li>
157
149
  * <li>
158
- * <p>To learn more about Performance Insights and Amazon RDS DB instances, go to the <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html"> Amazon RDS User Guide</a>.
159
- * </p>
150
+ * <p>To learn more about Performance Insights and Amazon RDS DB instances, go to the <i>
151
+ * <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html"> Amazon RDS User Guide</a>
152
+ * </i>. </p>
153
+ * </li>
154
+ * <li>
155
+ * <p>To learn more about Performance Insights and Amazon DocumentDB clusters, go to the <i>
156
+ * <a href="https://docs.aws.amazon.com/documentdb/latest/developerguide/performance-insights.html"> Amazon DocumentDB Developer Guide</a>
157
+ * </i>.</p>
160
158
  * </li>
161
159
  * </ul>
162
160
  */
package/dist-types/commands/GetDimensionKeyDetailsCommand.d.ts CHANGED
@@ -7,11 +7,10 @@ export interface GetDimensionKeyDetailsCommandInput extends GetDimensionKeyDetai
7
7
  export interface GetDimensionKeyDetailsCommandOutput extends GetDimensionKeyDetailsResponse, __MetadataBearer {
8
8
  }
9
9
  /**
10
- * <p>Get the attributes of the specified dimension group for a DB instance or data source.
11
- * For example, if you specify a SQL ID, <code>GetDimensionKeyDetails</code> retrieves
12
- * the full text of the dimension <code>db.sql.statement</code>cassociated with this ID.
13
- * This operation is useful because <code>GetResourceMetrics</code> and <code>DescribeDimensionKeys</code>
14
- * don't support retrieval of large SQL statement text.</p>
10
+ * <p>Get the attributes of the specified dimension group for a DB instance or data source. For example, if you specify a SQL ID,
11
+ * <code>GetDimensionKeyDetails</code> retrieves the full text of the dimension <code>db.sql.statement</code> associated with this ID.
12
+ * This operation is useful because <code>GetResourceMetrics</code> and <code>DescribeDimensionKeys</code> don't support retrieval of large
13
+ * SQL statement text.</p>
15
14
  * @example
16
15
  * Use a bare-bones client and the command you need to make an API call.
17
16
  * ```javascript
package/dist-types/commands/GetResourceMetricsCommand.d.ts CHANGED
@@ -7,7 +7,7 @@ export interface GetResourceMetricsCommandInput extends GetResourceMetricsReques
7
7
  export interface GetResourceMetricsCommandOutput extends GetResourceMetricsResponse, __MetadataBearer {
8
8
  }
9
9
  /**
10
- * <p>Retrieve Performance Insights metrics for a set of data sources, over a time period. You can provide
10
+ * <p>Retrieve Performance Insights metrics for a set of data sources over a time period. You can provide
11
11
  * specific dimension groups and dimensions, and provide aggregation and filtering criteria for
12
12
  * each group.</p>
13
13
  * <note>