@aws-sdk/client-pi 3.46.0 → 3.48.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.
- package/CHANGELOG.md +38 -0
- package/README.md +18 -13
- package/dist-cjs/PI.js +45 -0
- package/dist-cjs/commands/GetResourceMetadataCommand.js +36 -0
- package/dist-cjs/commands/ListAvailableResourceDimensionsCommand.js +36 -0
- package/dist-cjs/commands/ListAvailableResourceMetricsCommand.js +36 -0
- package/dist-cjs/commands/index.js +3 -0
- package/dist-cjs/index.js +1 -0
- package/dist-cjs/models/models_0.js +77 -19
- package/dist-cjs/pagination/DescribeDimensionKeysPaginator.js +35 -0
- package/dist-cjs/pagination/GetResourceMetricsPaginator.js +35 -0
- package/dist-cjs/pagination/Interfaces.js +2 -0
- package/dist-cjs/pagination/ListAvailableResourceDimensionsPaginator.js +35 -0
- package/dist-cjs/pagination/ListAvailableResourceMetricsPaginator.js +35 -0
- package/dist-cjs/pagination/index.js +8 -0
- package/dist-cjs/protocols/Aws_json1_1.js +402 -1
- package/dist-cjs/runtimeConfig.browser.js +7 -2
- package/dist-cjs/runtimeConfig.js +10 -2
- package/dist-es/PI.js +45 -0
- package/dist-es/commands/GetResourceMetadataCommand.js +39 -0
- package/dist-es/commands/ListAvailableResourceDimensionsCommand.js +39 -0
- package/dist-es/commands/ListAvailableResourceMetricsCommand.js +39 -0
- package/dist-es/commands/index.js +3 -0
- package/dist-es/index.js +1 -0
- package/dist-es/models/models_0.js +54 -12
- package/dist-es/pagination/DescribeDimensionKeysPaginator.js +74 -0
- package/dist-es/pagination/GetResourceMetricsPaginator.js +74 -0
- package/dist-es/pagination/Interfaces.js +1 -0
- package/dist-es/pagination/ListAvailableResourceDimensionsPaginator.js +74 -0
- package/dist-es/pagination/ListAvailableResourceMetricsPaginator.js +74 -0
- package/dist-es/pagination/index.js +5 -0
- package/dist-es/protocols/Aws_json1_1.js +414 -1
- package/dist-es/runtimeConfig.browser.js +12 -3
- package/dist-es/runtimeConfig.js +13 -4
- package/dist-types/PI.d.ts +48 -18
- package/dist-types/PIClient.d.ts +27 -15
- package/dist-types/commands/DescribeDimensionKeysCommand.d.ts +2 -2
- package/dist-types/commands/GetDimensionKeyDetailsCommand.d.ts +5 -4
- package/dist-types/commands/GetResourceMetadataCommand.d.ts +37 -0
- package/dist-types/commands/ListAvailableResourceDimensionsCommand.d.ts +35 -0
- package/dist-types/commands/ListAvailableResourceMetricsCommand.d.ts +36 -0
- package/dist-types/commands/index.d.ts +3 -0
- package/dist-types/index.d.ts +1 -0
- package/dist-types/models/models_0.d.ts +413 -101
- package/dist-types/pagination/DescribeDimensionKeysPaginator.d.ts +4 -0
- package/dist-types/pagination/GetResourceMetricsPaginator.d.ts +4 -0
- package/dist-types/pagination/Interfaces.d.ts +6 -0
- package/dist-types/pagination/ListAvailableResourceDimensionsPaginator.d.ts +4 -0
- package/dist-types/pagination/ListAvailableResourceMetricsPaginator.d.ts +4 -0
- package/dist-types/pagination/index.d.ts +5 -0
- package/dist-types/protocols/Aws_json1_1.d.ts +9 -0
- package/dist-types/runtimeConfig.browser.d.ts +3 -2
- package/dist-types/runtimeConfig.d.ts +4 -3
- package/dist-types/runtimeConfig.native.d.ts +1 -0
- package/dist-types/ts3.4/PI.d.ts +15 -0
- package/dist-types/ts3.4/PIClient.d.ts +8 -3
- package/dist-types/ts3.4/commands/GetResourceMetadataCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/ListAvailableResourceDimensionsCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/ListAvailableResourceMetricsCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/index.d.ts +3 -0
- package/dist-types/ts3.4/index.d.ts +1 -0
- package/dist-types/ts3.4/models/models_0.d.ts +142 -12
- package/dist-types/ts3.4/pagination/DescribeDimensionKeysPaginator.d.ts +4 -0
- package/dist-types/ts3.4/pagination/GetResourceMetricsPaginator.d.ts +4 -0
- package/dist-types/ts3.4/pagination/Interfaces.d.ts +6 -0
- package/dist-types/ts3.4/pagination/ListAvailableResourceDimensionsPaginator.d.ts +4 -0
- package/dist-types/ts3.4/pagination/ListAvailableResourceMetricsPaginator.d.ts +4 -0
- package/dist-types/ts3.4/pagination/index.d.ts +5 -0
- package/dist-types/ts3.4/protocols/Aws_json1_1.d.ts +9 -0
- package/dist-types/ts3.4/runtimeConfig.browser.d.ts +3 -2
- package/dist-types/ts3.4/runtimeConfig.d.ts +4 -3
- package/dist-types/ts3.4/runtimeConfig.native.d.ts +1 -0
- package/package.json +35 -35
package/dist-types/PI.d.ts
CHANGED
|
@@ -1,36 +1,44 @@
|
|
|
1
1
|
import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types";
|
|
2
2
|
import { DescribeDimensionKeysCommandInput, DescribeDimensionKeysCommandOutput } from "./commands/DescribeDimensionKeysCommand";
|
|
3
3
|
import { GetDimensionKeyDetailsCommandInput, GetDimensionKeyDetailsCommandOutput } from "./commands/GetDimensionKeyDetailsCommand";
|
|
4
|
+
import { GetResourceMetadataCommandInput, GetResourceMetadataCommandOutput } from "./commands/GetResourceMetadataCommand";
|
|
4
5
|
import { GetResourceMetricsCommandInput, GetResourceMetricsCommandOutput } from "./commands/GetResourceMetricsCommand";
|
|
6
|
+
import { ListAvailableResourceDimensionsCommandInput, ListAvailableResourceDimensionsCommandOutput } from "./commands/ListAvailableResourceDimensionsCommand";
|
|
7
|
+
import { ListAvailableResourceMetricsCommandInput, ListAvailableResourceMetricsCommandOutput } from "./commands/ListAvailableResourceMetricsCommand";
|
|
5
8
|
import { PIClient } from "./PIClient";
|
|
6
9
|
/**
|
|
7
10
|
* <fullname>Amazon RDS Performance Insights</fullname>
|
|
8
11
|
*
|
|
9
|
-
* <p>Amazon RDS Performance Insights enables you to monitor and explore different dimensions of
|
|
10
|
-
*
|
|
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>
|
|
12
16
|
*
|
|
13
|
-
* <p>When Performance Insights is enabled, the Amazon RDS Performance Insights API provides visibility into the performance of your DB instance.
|
|
14
|
-
*
|
|
15
|
-
*
|
|
16
|
-
*
|
|
17
|
-
*
|
|
18
|
-
*
|
|
19
|
-
*
|
|
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>
|
|
20
26
|
*
|
|
21
27
|
* <ul>
|
|
22
28
|
* <li>
|
|
23
|
-
* <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
|
|
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>
|
|
24
31
|
* </li>
|
|
25
32
|
* <li>
|
|
26
|
-
* <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
|
|
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>
|
|
27
35
|
* </li>
|
|
28
36
|
* </ul>
|
|
29
37
|
*/
|
|
30
38
|
export declare class PI extends PIClient {
|
|
31
39
|
/**
|
|
32
|
-
* <p>For a specific time period, retrieve the top <code>N</code> dimension keys for a
|
|
33
|
-
*
|
|
40
|
+
* <p>For a specific time period, retrieve the top <code>N</code> dimension keys for a metric.
|
|
41
|
+
* </p>
|
|
34
42
|
* <note>
|
|
35
43
|
* <p>Each response element returns a maximum of 500 bytes. For larger elements, such as SQL statements,
|
|
36
44
|
* only the first 500 bytes are returned.</p>
|
|
@@ -40,14 +48,23 @@ export declare class PI extends PIClient {
|
|
|
40
48
|
describeDimensionKeys(args: DescribeDimensionKeysCommandInput, cb: (err: any, data?: DescribeDimensionKeysCommandOutput) => void): void;
|
|
41
49
|
describeDimensionKeys(args: DescribeDimensionKeysCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDimensionKeysCommandOutput) => void): void;
|
|
42
50
|
/**
|
|
43
|
-
* <p>Get the attributes of the specified dimension group for a DB instance or data source.
|
|
44
|
-
*
|
|
45
|
-
*
|
|
46
|
-
*
|
|
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>
|
|
47
56
|
*/
|
|
48
57
|
getDimensionKeyDetails(args: GetDimensionKeyDetailsCommandInput, options?: __HttpHandlerOptions): Promise<GetDimensionKeyDetailsCommandOutput>;
|
|
49
58
|
getDimensionKeyDetails(args: GetDimensionKeyDetailsCommandInput, cb: (err: any, data?: GetDimensionKeyDetailsCommandOutput) => void): void;
|
|
50
59
|
getDimensionKeyDetails(args: GetDimensionKeyDetailsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDimensionKeyDetailsCommandOutput) => void): void;
|
|
60
|
+
/**
|
|
61
|
+
* <p>Retrieve the metadata for different features. For example, the metadata might indicate
|
|
62
|
+
* that a feature is turned on or off on a specific DB instance.
|
|
63
|
+
* </p>
|
|
64
|
+
*/
|
|
65
|
+
getResourceMetadata(args: GetResourceMetadataCommandInput, options?: __HttpHandlerOptions): Promise<GetResourceMetadataCommandOutput>;
|
|
66
|
+
getResourceMetadata(args: GetResourceMetadataCommandInput, cb: (err: any, data?: GetResourceMetadataCommandOutput) => void): void;
|
|
67
|
+
getResourceMetadata(args: GetResourceMetadataCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetResourceMetadataCommandOutput) => void): void;
|
|
51
68
|
/**
|
|
52
69
|
* <p>Retrieve Performance Insights metrics for a set of data sources, over a time period. You can provide
|
|
53
70
|
* specific dimension groups and dimensions, and provide aggregation and filtering criteria for
|
|
@@ -60,4 +77,17 @@ export declare class PI extends PIClient {
|
|
|
60
77
|
getResourceMetrics(args: GetResourceMetricsCommandInput, options?: __HttpHandlerOptions): Promise<GetResourceMetricsCommandOutput>;
|
|
61
78
|
getResourceMetrics(args: GetResourceMetricsCommandInput, cb: (err: any, data?: GetResourceMetricsCommandOutput) => void): void;
|
|
62
79
|
getResourceMetrics(args: GetResourceMetricsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetResourceMetricsCommandOutput) => void): void;
|
|
80
|
+
/**
|
|
81
|
+
* <p>Retrieve the dimensions that can be queried for each specified metric type on a specified DB instance.</p>
|
|
82
|
+
*/
|
|
83
|
+
listAvailableResourceDimensions(args: ListAvailableResourceDimensionsCommandInput, options?: __HttpHandlerOptions): Promise<ListAvailableResourceDimensionsCommandOutput>;
|
|
84
|
+
listAvailableResourceDimensions(args: ListAvailableResourceDimensionsCommandInput, cb: (err: any, data?: ListAvailableResourceDimensionsCommandOutput) => void): void;
|
|
85
|
+
listAvailableResourceDimensions(args: ListAvailableResourceDimensionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAvailableResourceDimensionsCommandOutput) => void): void;
|
|
86
|
+
/**
|
|
87
|
+
* <p>Retrieve metrics of the specified types that can be queried for a specified DB instance.
|
|
88
|
+
* </p>
|
|
89
|
+
*/
|
|
90
|
+
listAvailableResourceMetrics(args: ListAvailableResourceMetricsCommandInput, options?: __HttpHandlerOptions): Promise<ListAvailableResourceMetricsCommandOutput>;
|
|
91
|
+
listAvailableResourceMetrics(args: ListAvailableResourceMetricsCommandInput, cb: (err: any, data?: ListAvailableResourceMetricsCommandOutput) => void): void;
|
|
92
|
+
listAvailableResourceMetrics(args: ListAvailableResourceMetricsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAvailableResourceMetricsCommandOutput) => void): void;
|
|
63
93
|
}
|
package/dist-types/PIClient.d.ts
CHANGED
|
@@ -4,13 +4,16 @@ import { RetryInputConfig, RetryResolvedConfig } from "@aws-sdk/middleware-retry
|
|
|
4
4
|
import { AwsAuthInputConfig, AwsAuthResolvedConfig } from "@aws-sdk/middleware-signing";
|
|
5
5
|
import { UserAgentInputConfig, UserAgentResolvedConfig } from "@aws-sdk/middleware-user-agent";
|
|
6
6
|
import { HttpHandler as __HttpHandler } from "@aws-sdk/protocol-http";
|
|
7
|
-
import { Client as __Client, SmithyConfiguration as __SmithyConfiguration, SmithyResolvedConfiguration as __SmithyResolvedConfiguration } from "@aws-sdk/smithy-client";
|
|
7
|
+
import { Client as __Client, DefaultsMode, SmithyConfiguration as __SmithyConfiguration, SmithyResolvedConfiguration as __SmithyResolvedConfiguration } from "@aws-sdk/smithy-client";
|
|
8
8
|
import { Credentials as __Credentials, Decoder as __Decoder, Encoder as __Encoder, HashConstructor as __HashConstructor, HttpHandlerOptions as __HttpHandlerOptions, Logger as __Logger, Provider as __Provider, Provider, RegionInfoProvider, StreamCollector as __StreamCollector, UrlParser as __UrlParser, UserAgent as __UserAgent } from "@aws-sdk/types";
|
|
9
9
|
import { DescribeDimensionKeysCommandInput, DescribeDimensionKeysCommandOutput } from "./commands/DescribeDimensionKeysCommand";
|
|
10
10
|
import { GetDimensionKeyDetailsCommandInput, GetDimensionKeyDetailsCommandOutput } from "./commands/GetDimensionKeyDetailsCommand";
|
|
11
|
+
import { GetResourceMetadataCommandInput, GetResourceMetadataCommandOutput } from "./commands/GetResourceMetadataCommand";
|
|
11
12
|
import { GetResourceMetricsCommandInput, GetResourceMetricsCommandOutput } from "./commands/GetResourceMetricsCommand";
|
|
12
|
-
|
|
13
|
-
|
|
13
|
+
import { ListAvailableResourceDimensionsCommandInput, ListAvailableResourceDimensionsCommandOutput } from "./commands/ListAvailableResourceDimensionsCommand";
|
|
14
|
+
import { ListAvailableResourceMetricsCommandInput, ListAvailableResourceMetricsCommandOutput } from "./commands/ListAvailableResourceMetricsCommand";
|
|
15
|
+
export declare type ServiceInputTypes = DescribeDimensionKeysCommandInput | GetDimensionKeyDetailsCommandInput | GetResourceMetadataCommandInput | GetResourceMetricsCommandInput | ListAvailableResourceDimensionsCommandInput | ListAvailableResourceMetricsCommandInput;
|
|
16
|
+
export declare type ServiceOutputTypes = DescribeDimensionKeysCommandOutput | GetDimensionKeyDetailsCommandOutput | GetResourceMetadataCommandOutput | GetResourceMetricsCommandOutput | ListAvailableResourceDimensionsCommandOutput | ListAvailableResourceMetricsCommandOutput;
|
|
14
17
|
export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
|
|
15
18
|
/**
|
|
16
19
|
* The HTTP handler to use. Fetch in browser and Https in Nodejs.
|
|
@@ -111,6 +114,10 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
|
|
|
111
114
|
* @internal
|
|
112
115
|
*/
|
|
113
116
|
defaultUserAgentProvider?: Provider<__UserAgent>;
|
|
117
|
+
/**
|
|
118
|
+
* The {@link DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
|
|
119
|
+
*/
|
|
120
|
+
defaultsMode?: DefaultsMode | Provider<DefaultsMode>;
|
|
114
121
|
}
|
|
115
122
|
declare type PIClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & RegionInputConfig & EndpointsInputConfig & RetryInputConfig & HostHeaderInputConfig & AwsAuthInputConfig & UserAgentInputConfig;
|
|
116
123
|
/**
|
|
@@ -127,24 +134,29 @@ export interface PIClientResolvedConfig extends PIClientResolvedConfigType {
|
|
|
127
134
|
/**
|
|
128
135
|
* <fullname>Amazon RDS Performance Insights</fullname>
|
|
129
136
|
*
|
|
130
|
-
* <p>Amazon RDS Performance Insights enables you to monitor and explore different dimensions of
|
|
131
|
-
*
|
|
132
|
-
*
|
|
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>
|
|
133
141
|
*
|
|
134
|
-
* <p>When Performance Insights is enabled, the Amazon RDS Performance Insights API provides visibility into the performance of your DB instance.
|
|
135
|
-
*
|
|
136
|
-
*
|
|
137
|
-
*
|
|
138
|
-
*
|
|
139
|
-
*
|
|
140
|
-
*
|
|
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>
|
|
141
151
|
*
|
|
142
152
|
* <ul>
|
|
143
153
|
* <li>
|
|
144
|
-
* <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
|
|
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
156
|
* </li>
|
|
146
157
|
* <li>
|
|
147
|
-
* <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
|
|
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>
|
|
148
160
|
* </li>
|
|
149
161
|
* </ul>
|
|
150
162
|
*/
|
|
@@ -7,8 +7,8 @@ export interface DescribeDimensionKeysCommandInput extends DescribeDimensionKeys
|
|
|
7
7
|
export interface DescribeDimensionKeysCommandOutput extends DescribeDimensionKeysResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>For a specific time period, retrieve the top <code>N</code> dimension keys for a
|
|
11
|
-
*
|
|
10
|
+
* <p>For a specific time period, retrieve the top <code>N</code> dimension keys for a metric.
|
|
11
|
+
* </p>
|
|
12
12
|
* <note>
|
|
13
13
|
* <p>Each response element returns a maximum of 500 bytes. For larger elements, such as SQL statements,
|
|
14
14
|
* only the first 500 bytes are returned.</p>
|
|
@@ -7,10 +7,11 @@ 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
|
-
*
|
|
12
|
-
*
|
|
13
|
-
*
|
|
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>
|
|
14
15
|
* @example
|
|
15
16
|
* Use a bare-bones client and the command you need to make an API call.
|
|
16
17
|
* ```javascript
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
import { Command as $Command } from "@aws-sdk/smithy-client";
|
|
2
|
+
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
|
|
3
|
+
import { GetResourceMetadataRequest, GetResourceMetadataResponse } from "../models/models_0";
|
|
4
|
+
import { PIClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PIClient";
|
|
5
|
+
export interface GetResourceMetadataCommandInput extends GetResourceMetadataRequest {
|
|
6
|
+
}
|
|
7
|
+
export interface GetResourceMetadataCommandOutput extends GetResourceMetadataResponse, __MetadataBearer {
|
|
8
|
+
}
|
|
9
|
+
/**
|
|
10
|
+
* <p>Retrieve the metadata for different features. For example, the metadata might indicate
|
|
11
|
+
* that a feature is turned on or off on a specific DB instance.
|
|
12
|
+
* </p>
|
|
13
|
+
* @example
|
|
14
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
15
|
+
* ```javascript
|
|
16
|
+
* import { PIClient, GetResourceMetadataCommand } from "@aws-sdk/client-pi"; // ES Modules import
|
|
17
|
+
* // const { PIClient, GetResourceMetadataCommand } = require("@aws-sdk/client-pi"); // CommonJS import
|
|
18
|
+
* const client = new PIClient(config);
|
|
19
|
+
* const command = new GetResourceMetadataCommand(input);
|
|
20
|
+
* const response = await client.send(command);
|
|
21
|
+
* ```
|
|
22
|
+
*
|
|
23
|
+
* @see {@link GetResourceMetadataCommandInput} for command's `input` shape.
|
|
24
|
+
* @see {@link GetResourceMetadataCommandOutput} for command's `response` shape.
|
|
25
|
+
* @see {@link PIClientResolvedConfig | config} for PIClient's `config` shape.
|
|
26
|
+
*
|
|
27
|
+
*/
|
|
28
|
+
export declare class GetResourceMetadataCommand extends $Command<GetResourceMetadataCommandInput, GetResourceMetadataCommandOutput, PIClientResolvedConfig> {
|
|
29
|
+
readonly input: GetResourceMetadataCommandInput;
|
|
30
|
+
constructor(input: GetResourceMetadataCommandInput);
|
|
31
|
+
/**
|
|
32
|
+
* @internal
|
|
33
|
+
*/
|
|
34
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PIClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetResourceMetadataCommandInput, GetResourceMetadataCommandOutput>;
|
|
35
|
+
private serialize;
|
|
36
|
+
private deserialize;
|
|
37
|
+
}
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
import { Command as $Command } from "@aws-sdk/smithy-client";
|
|
2
|
+
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
|
|
3
|
+
import { ListAvailableResourceDimensionsRequest, ListAvailableResourceDimensionsResponse } from "../models/models_0";
|
|
4
|
+
import { PIClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PIClient";
|
|
5
|
+
export interface ListAvailableResourceDimensionsCommandInput extends ListAvailableResourceDimensionsRequest {
|
|
6
|
+
}
|
|
7
|
+
export interface ListAvailableResourceDimensionsCommandOutput extends ListAvailableResourceDimensionsResponse, __MetadataBearer {
|
|
8
|
+
}
|
|
9
|
+
/**
|
|
10
|
+
* <p>Retrieve the dimensions that can be queried for each specified metric type on a specified DB instance.</p>
|
|
11
|
+
* @example
|
|
12
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
13
|
+
* ```javascript
|
|
14
|
+
* import { PIClient, ListAvailableResourceDimensionsCommand } from "@aws-sdk/client-pi"; // ES Modules import
|
|
15
|
+
* // const { PIClient, ListAvailableResourceDimensionsCommand } = require("@aws-sdk/client-pi"); // CommonJS import
|
|
16
|
+
* const client = new PIClient(config);
|
|
17
|
+
* const command = new ListAvailableResourceDimensionsCommand(input);
|
|
18
|
+
* const response = await client.send(command);
|
|
19
|
+
* ```
|
|
20
|
+
*
|
|
21
|
+
* @see {@link ListAvailableResourceDimensionsCommandInput} for command's `input` shape.
|
|
22
|
+
* @see {@link ListAvailableResourceDimensionsCommandOutput} for command's `response` shape.
|
|
23
|
+
* @see {@link PIClientResolvedConfig | config} for PIClient's `config` shape.
|
|
24
|
+
*
|
|
25
|
+
*/
|
|
26
|
+
export declare class ListAvailableResourceDimensionsCommand extends $Command<ListAvailableResourceDimensionsCommandInput, ListAvailableResourceDimensionsCommandOutput, PIClientResolvedConfig> {
|
|
27
|
+
readonly input: ListAvailableResourceDimensionsCommandInput;
|
|
28
|
+
constructor(input: ListAvailableResourceDimensionsCommandInput);
|
|
29
|
+
/**
|
|
30
|
+
* @internal
|
|
31
|
+
*/
|
|
32
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PIClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListAvailableResourceDimensionsCommandInput, ListAvailableResourceDimensionsCommandOutput>;
|
|
33
|
+
private serialize;
|
|
34
|
+
private deserialize;
|
|
35
|
+
}
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
import { Command as $Command } from "@aws-sdk/smithy-client";
|
|
2
|
+
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
|
|
3
|
+
import { ListAvailableResourceMetricsRequest, ListAvailableResourceMetricsResponse } from "../models/models_0";
|
|
4
|
+
import { PIClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PIClient";
|
|
5
|
+
export interface ListAvailableResourceMetricsCommandInput extends ListAvailableResourceMetricsRequest {
|
|
6
|
+
}
|
|
7
|
+
export interface ListAvailableResourceMetricsCommandOutput extends ListAvailableResourceMetricsResponse, __MetadataBearer {
|
|
8
|
+
}
|
|
9
|
+
/**
|
|
10
|
+
* <p>Retrieve metrics of the specified types that can be queried for a specified DB instance.
|
|
11
|
+
* </p>
|
|
12
|
+
* @example
|
|
13
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
14
|
+
* ```javascript
|
|
15
|
+
* import { PIClient, ListAvailableResourceMetricsCommand } from "@aws-sdk/client-pi"; // ES Modules import
|
|
16
|
+
* // const { PIClient, ListAvailableResourceMetricsCommand } = require("@aws-sdk/client-pi"); // CommonJS import
|
|
17
|
+
* const client = new PIClient(config);
|
|
18
|
+
* const command = new ListAvailableResourceMetricsCommand(input);
|
|
19
|
+
* const response = await client.send(command);
|
|
20
|
+
* ```
|
|
21
|
+
*
|
|
22
|
+
* @see {@link ListAvailableResourceMetricsCommandInput} for command's `input` shape.
|
|
23
|
+
* @see {@link ListAvailableResourceMetricsCommandOutput} for command's `response` shape.
|
|
24
|
+
* @see {@link PIClientResolvedConfig | config} for PIClient's `config` shape.
|
|
25
|
+
*
|
|
26
|
+
*/
|
|
27
|
+
export declare class ListAvailableResourceMetricsCommand extends $Command<ListAvailableResourceMetricsCommandInput, ListAvailableResourceMetricsCommandOutput, PIClientResolvedConfig> {
|
|
28
|
+
readonly input: ListAvailableResourceMetricsCommandInput;
|
|
29
|
+
constructor(input: ListAvailableResourceMetricsCommandInput);
|
|
30
|
+
/**
|
|
31
|
+
* @internal
|
|
32
|
+
*/
|
|
33
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PIClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListAvailableResourceMetricsCommandInput, ListAvailableResourceMetricsCommandOutput>;
|
|
34
|
+
private serialize;
|
|
35
|
+
private deserialize;
|
|
36
|
+
}
|
|
@@ -1,3 +1,6 @@
|
|
|
1
1
|
export * from "./DescribeDimensionKeysCommand";
|
|
2
2
|
export * from "./GetDimensionKeyDetailsCommand";
|
|
3
|
+
export * from "./GetResourceMetadataCommand";
|
|
3
4
|
export * from "./GetResourceMetricsCommand";
|
|
5
|
+
export * from "./ListAvailableResourceDimensionsCommand";
|
|
6
|
+
export * from "./ListAvailableResourceMetricsCommand";
|
package/dist-types/index.d.ts
CHANGED