@aws-sdk/client-pi 3.47.2 → 3.51.0

package/dist-types/PIClient.d.ts

@@ -8,9 +8,12 @@ import { Client as __Client, DefaultsMode, SmithyConfiguration as __SmithyConfig
 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";
 import { DescribeDimensionKeysCommandInput, DescribeDimensionKeysCommandOutput } from "./commands/DescribeDimensionKeysCommand";
 import { GetDimensionKeyDetailsCommandInput, GetDimensionKeyDetailsCommandOutput } from "./commands/GetDimensionKeyDetailsCommand";
+import { GetResourceMetadataCommandInput, GetResourceMetadataCommandOutput } from "./commands/GetResourceMetadataCommand";
 import { GetResourceMetricsCommandInput, GetResourceMetricsCommandOutput } from "./commands/GetResourceMetricsCommand";
-export declare type ServiceInputTypes = DescribeDimensionKeysCommandInput | GetDimensionKeyDetailsCommandInput | GetResourceMetricsCommandInput;
-export declare type ServiceOutputTypes = DescribeDimensionKeysCommandOutput | GetDimensionKeyDetailsCommandOutput | GetResourceMetricsCommandOutput;
+import { ListAvailableResourceDimensionsCommandInput, ListAvailableResourceDimensionsCommandOutput } from "./commands/ListAvailableResourceDimensionsCommand";
+import { ListAvailableResourceMetricsCommandInput, ListAvailableResourceMetricsCommandOutput } from "./commands/ListAvailableResourceMetricsCommand";
+export declare type ServiceInputTypes = DescribeDimensionKeysCommandInput | GetDimensionKeyDetailsCommandInput | GetResourceMetadataCommandInput | GetResourceMetricsCommandInput | ListAvailableResourceDimensionsCommandInput | ListAvailableResourceMetricsCommandInput;
+export declare type ServiceOutputTypes = DescribeDimensionKeysCommandOutput | GetDimensionKeyDetailsCommandOutput | GetResourceMetadataCommandOutput | GetResourceMetricsCommandOutput | ListAvailableResourceDimensionsCommandOutput | ListAvailableResourceMetricsCommandOutput;
 export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
     /**
      * The HTTP handler to use. Fetch in browser and Https in Nodejs.
@@ -131,24 +134,29 @@ export interface PIClientResolvedConfig extends PIClientResolvedConfigType {
 /**
  * <fullname>Amazon RDS Performance Insights</fullname>
  *
- *          <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 provides detailed
- *       information about Performance Insights data types, parameters and errors.</p>
+ *          <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 provides detailed information about Performance Insights
+ *           data types, parameters and errors.
+ *       </p>
  *
- *          <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 authoritative source for AWS service-vended monitoring metrics.  Performance Insights offers a domain-specific
- *       view of DB load. </p>
- *          <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 provides DB load data for each time point in the queried time range. Each time
- *       point decomposes overall load in relation to the requested dimensions, measured at that time point. Examples include
- *       SQL, Wait event, User, and Host.</p>
+ *          <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 authoritative source for Amazon Web Services service-vended monitoring metrics.
+ *           Performance Insights offers a domain-specific view of DB load.
+ *       </p>
+ *          <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 provides DB load data for each time point in the
+ *           queried time range. Each time point decomposes overall load in relation to the requested dimensions,
+ *           measured at that time point. Examples include SQL, Wait event, User, and Host.
+ *       </p>
  *
  *          <ul>
  *             <li>
- *                <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>.</p>
+ *                <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>.
+ *             </p>
  *             </li>
  *             <li>
- *                <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>.</p>
+ *                <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>.
+ *             </p>
  *             </li>
  *          </ul>
  */

package/dist-types/commands/DescribeDimensionKeysCommand.d.ts

@@ -7,8 +7,8 @@ export interface DescribeDimensionKeysCommandInput extends DescribeDimensionKeys
 export interface DescribeDimensionKeysCommandOutput extends DescribeDimensionKeysResponse, __MetadataBearer {
 }
 /**
- * <p>For a specific time period, retrieve the top <code>N</code> dimension keys for a
- *       metric.</p>
+ * <p>For a specific time period, retrieve the top <code>N</code> dimension keys for a metric.
+ *       </p>
  *          <note>
  *             <p>Each response element returns a maximum of 500 bytes. For larger elements, such as SQL statements,
  *         only the first 500 bytes are returned.</p>

package/dist-types/commands/GetDimensionKeyDetailsCommand.d.ts

@@ -7,10 +7,11 @@ export interface GetDimensionKeyDetailsCommandInput extends GetDimensionKeyDetai
 export interface GetDimensionKeyDetailsCommandOutput extends GetDimensionKeyDetailsResponse, __MetadataBearer {
 }
 /**
- * <p>Get the attributes of the specified dimension group for a DB instance or data source. For example, if you specify a
- *       SQL ID, <code>GetDimensionKeyDetails</code> retrieves the full text of the dimension <code>db.sql.statement</code>
- *       associated with this ID. This operation is useful because <code>GetResourceMetrics</code> and
- *         <code>DescribeDimensionKeys</code> don't support retrieval of large SQL statement text.</p>
+ * <p>Get the attributes of the specified dimension group for a DB instance or data source.
+ *           For example, if you specify a SQL ID, <code>GetDimensionKeyDetails</code> retrieves
+ *           the full text of the dimension <code>db.sql.statement</code>cassociated with this ID.
+ *           This operation is useful because <code>GetResourceMetrics</code> and <code>DescribeDimensionKeys</code>
+ *           don't support retrieval of large SQL statement text.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

package/dist-types/commands/GetResourceMetadataCommand.d.ts

@@ -0,0 +1,37 @@
+import { Command as $Command } from "@aws-sdk/smithy-client";
+import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
+import { GetResourceMetadataRequest, GetResourceMetadataResponse } from "../models/models_0";
+import { PIClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PIClient";
+export interface GetResourceMetadataCommandInput extends GetResourceMetadataRequest {
+}
+export interface GetResourceMetadataCommandOutput extends GetResourceMetadataResponse, __MetadataBearer {
+}
+/**
+ * <p>Retrieve the metadata for different features. For example, the metadata might indicate
+ *             that a feature is turned on or off on a specific DB instance.
+ *         </p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { PIClient, GetResourceMetadataCommand } from "@aws-sdk/client-pi"; // ES Modules import
+ * // const { PIClient, GetResourceMetadataCommand } = require("@aws-sdk/client-pi"); // CommonJS import
+ * const client = new PIClient(config);
+ * const command = new GetResourceMetadataCommand(input);
+ * const response = await client.send(command);
+ * ```
+ *
+ * @see {@link GetResourceMetadataCommandInput} for command's `input` shape.
+ * @see {@link GetResourceMetadataCommandOutput} for command's `response` shape.
+ * @see {@link PIClientResolvedConfig | config} for PIClient's `config` shape.
+ *
+ */
+export declare class GetResourceMetadataCommand extends $Command<GetResourceMetadataCommandInput, GetResourceMetadataCommandOutput, PIClientResolvedConfig> {
+    readonly input: GetResourceMetadataCommandInput;
+    constructor(input: GetResourceMetadataCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PIClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetResourceMetadataCommandInput, GetResourceMetadataCommandOutput>;
+    private serialize;
+    private deserialize;
+}

package/dist-types/commands/ListAvailableResourceDimensionsCommand.d.ts

@@ -0,0 +1,35 @@
+import { Command as $Command } from "@aws-sdk/smithy-client";
+import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
+import { ListAvailableResourceDimensionsRequest, ListAvailableResourceDimensionsResponse } from "../models/models_0";
+import { PIClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PIClient";
+export interface ListAvailableResourceDimensionsCommandInput extends ListAvailableResourceDimensionsRequest {
+}
+export interface ListAvailableResourceDimensionsCommandOutput extends ListAvailableResourceDimensionsResponse, __MetadataBearer {
+}
+/**
+ * <p>Retrieve the dimensions that can be queried for each specified metric type on a specified DB instance.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { PIClient, ListAvailableResourceDimensionsCommand } from "@aws-sdk/client-pi"; // ES Modules import
+ * // const { PIClient, ListAvailableResourceDimensionsCommand } = require("@aws-sdk/client-pi"); // CommonJS import
+ * const client = new PIClient(config);
+ * const command = new ListAvailableResourceDimensionsCommand(input);
+ * const response = await client.send(command);
+ * ```
+ *
+ * @see {@link ListAvailableResourceDimensionsCommandInput} for command's `input` shape.
+ * @see {@link ListAvailableResourceDimensionsCommandOutput} for command's `response` shape.
+ * @see {@link PIClientResolvedConfig | config} for PIClient's `config` shape.
+ *
+ */
+export declare class ListAvailableResourceDimensionsCommand extends $Command<ListAvailableResourceDimensionsCommandInput, ListAvailableResourceDimensionsCommandOutput, PIClientResolvedConfig> {
+    readonly input: ListAvailableResourceDimensionsCommandInput;
+    constructor(input: ListAvailableResourceDimensionsCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PIClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListAvailableResourceDimensionsCommandInput, ListAvailableResourceDimensionsCommandOutput>;
+    private serialize;
+    private deserialize;
+}

package/dist-types/commands/ListAvailableResourceMetricsCommand.d.ts

@@ -0,0 +1,36 @@
+import { Command as $Command } from "@aws-sdk/smithy-client";
+import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
+import { ListAvailableResourceMetricsRequest, ListAvailableResourceMetricsResponse } from "../models/models_0";
+import { PIClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../PIClient";
+export interface ListAvailableResourceMetricsCommandInput extends ListAvailableResourceMetricsRequest {
+}
+export interface ListAvailableResourceMetricsCommandOutput extends ListAvailableResourceMetricsResponse, __MetadataBearer {
+}
+/**
+ * <p>Retrieve metrics of the specified types that can be queried for a specified DB instance.
+ *       </p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { PIClient, ListAvailableResourceMetricsCommand } from "@aws-sdk/client-pi"; // ES Modules import
+ * // const { PIClient, ListAvailableResourceMetricsCommand } = require("@aws-sdk/client-pi"); // CommonJS import
+ * const client = new PIClient(config);
+ * const command = new ListAvailableResourceMetricsCommand(input);
+ * const response = await client.send(command);
+ * ```
+ *
+ * @see {@link ListAvailableResourceMetricsCommandInput} for command's `input` shape.
+ * @see {@link ListAvailableResourceMetricsCommandOutput} for command's `response` shape.
+ * @see {@link PIClientResolvedConfig | config} for PIClient's `config` shape.
+ *
+ */
+export declare class ListAvailableResourceMetricsCommand extends $Command<ListAvailableResourceMetricsCommandInput, ListAvailableResourceMetricsCommandOutput, PIClientResolvedConfig> {
+    readonly input: ListAvailableResourceMetricsCommandInput;
+    constructor(input: ListAvailableResourceMetricsCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: PIClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListAvailableResourceMetricsCommandInput, ListAvailableResourceMetricsCommandOutput>;
+    private serialize;
+    private deserialize;
+}

package/dist-types/commands/index.d.ts

@@ -1,3 +1,6 @@
 export * from "./DescribeDimensionKeysCommand";
 export * from "./GetDimensionKeyDetailsCommand";
+export * from "./GetResourceMetadataCommand";
 export * from "./GetResourceMetricsCommand";
+export * from "./ListAvailableResourceDimensionsCommand";
+export * from "./ListAvailableResourceMetricsCommand";

package/dist-types/index.d.ts

@@ -2,3 +2,4 @@ export * from "./PI";
 export * from "./PIClient";
 export * from "./commands";
 export * from "./models";
+export * from "./pagination";